{"swagger":"2.0","info":{"version":"v1","title":"KashFlow.RestApi"},"host":"api.kashflow.com:443","basePath":"/v2","schemes":["https"],"paths":{"/accountantsaccess":{"get":{"tags":["AccountantsAccess"],"summary":"Get accountants linked to the current user's account.","operationId":"AccountantsAccess_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.AccountantsAccess.AccountantAccess"}}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"delete":{"tags":["AccountantsAccess"],"summary":"Revokes the accountant's access to the current user's account.","operationId":"AccountantsAccess_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"email","in":"query","description":"The accountant's email address.","required":true,"type":"string"}],"responses":{"204":{"description":"Accountant access revoked"},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/accountantsaccess/lookup":{"get":{"tags":["AccountantsAccess"],"summary":"Looks up an accountant by email address to verify they are registered and not already linked to the current user's account.","operationId":"AccountantsAccess_GetAccountantForAccess","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"email","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.AccountantsAccess.AccountantLookupResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Accountant not registered in the system"}},"deprecated":false}},"/accountingperiods":{"get":{"tags":["AccountingPeriod"],"summary":"This API allows a developer to retrieve a list of accounting periods available in specific IRIS KashFlow account.","operationId":"AccountingPeriod_GetAccountingPeriods","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Response.AccountingPeriodResponse"}}}},"deprecated":false},"post":{"tags":["AccountingPeriod"],"summary":"This API allows a developer to create a new accounting period.","operationId":"AccountingPeriod_SaveAccountingPeriods","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountingPeriodRequest","in":"body","description":"Accounting periods details to be updated","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Wrapper.AccountingPeriodWrapper"}}],"responses":{"200":{"description":"Save Accounting Periods"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/accountingperiods/{id}":{"delete":{"tags":["AccountingPeriod"],"summary":"This API allows developer to delete existing accounting period(s) with given ID and all the years after given ID.","operationId":"AccountingPeriod_DeleteAccountingPeriod","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"System generated unique Id of the accounting period. I which you want to delete.\r\n            Accounting period with such ID must be present.\r\n            One cannot delete accounting period after yearend posting.","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Accounting Periods Deleted"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Accounting Period Not Found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/accountsummary":{"get":{"tags":["AccountSummary"],"summary":"Get display settings and dashboard widget details","operationId":"AccountSummary_GetAccountSummary","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.AccountSummary"}}},"deprecated":false}},"/postcodes/{postcode}":{"get":{"tags":["AddressFinder"],"summary":"Returns the list of addresses for a postcode.","operationId":"AddressFinder_GetAddressFromPostcode","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"postcode","in":"path","description":"the postcode to retrieve","required":true,"type":"string"}],"responses":{"200":{"description":"Address details fetched based on postcode match.","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.IdealPostcodes.PostcodeResponse"}},"402":{"description":"4020 - Key balance depleted (No lookups remaining error) OR 4021 - Lookup Limit Reached (Limit breach error. Either daily or individual lookup limit has been reached.)","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Postcode not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/customers/{code}/advancepayments":{"get":{"tags":["AdvancePayment"],"summary":"Get the advance payment list for a customer, by code","operationId":"AdvancePayment_GetCustomerAdvancePayments","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"code","in":"path","description":"The customer code.","required":true,"type":"string"},{"name":"page","in":"query","description":"The page number.","required":false,"type":"integer","format":"int32"},{"name":"perpage","in":"query","description":"PerPage is number of records per page. (default is 10)","required":false,"type":"integer","format":"int32"},{"name":"order","in":"query","description":"sort list by ascending or descending order","required":false,"type":"string"},{"name":"sortby","in":"query","description":"sort column 1 = TransactionDate,  2 = Amount,  3 = Comment","required":false,"type":"integer","format":"int32","enum":[1,2,3]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Paging[KashFlow.Accounting.Model.AdvancePayment]"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No customer found with that code","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/suppliers/{code}/advancepayments":{"get":{"tags":["AdvancePayment"],"summary":"Get the advance payment list for a supplier, by code","operationId":"AdvancePayment_GetSupplierAdvancePayments","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"code","in":"path","description":"The supplier code.","required":true,"type":"string"},{"name":"page","in":"query","description":"The page number.","required":false,"type":"integer","format":"int32"},{"name":"perpage","in":"query","description":"PerPage is number of records per page. (default is 10)","required":false,"type":"integer","format":"int32"},{"name":"order","in":"query","description":"sort list by ascending or descending order","required":false,"type":"string"},{"name":"sortby","in":"query","description":"sort column 1 = TransactionDate,  2 = Amount,  3 = Comment","required":false,"type":"integer","format":"int32","enum":[1,2,3]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Paging[KashFlow.Accounting.Model.AdvancePayment]"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No supplier found with that code","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/reports/agedcreditors":{"get":{"tags":["AgedCreditorsReport"],"summary":"This API allows a developer to get age creditors report.\r\n            The Aged Creditors report is used to view the amount of money that you owe to, or are owed by, your suppliers (also known as creditors) until a specific date.\r\n            It will display the current balance you owe and the historical balance over the last three months and beyond.","operationId":"AgedCreditorsReport_GetReportForUser","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"endDate","in":"query","description":"The date you would like the report to run up until","required":true,"type":"string","format":"date-time"},{"name":"showBreakdown","in":"query","description":"Flag to indicate whether to show or hide breakdown. Default is false. i.e., breakdown is not shown.","required":false,"type":"boolean"},{"name":"showSupplier","in":"query","description":"Flag to show/hide Supplier even when the total owed is 0 (Even though there are unpaid purchases). Default is false.","required":false,"type":"boolean"},{"name":"sortOrder","in":"query","description":"Sorting order (asc or desc) (default is asc) 0 = Asc,  1 = Desc","required":false,"type":"integer","format":"int32","enum":[0,1]},{"name":"SortBy","in":"query","description":"Sort By column/field name. (default is name) 0 = Code,  1 = Name","required":false,"type":"integer","format":"int32","enum":[0,1]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.AgedCreditorsReport.AgedCreditorsReport"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/reports/ageddebtors":{"get":{"tags":["AgedDebtorsReport"],"summary":"This API allows a developer to get age debtors report.\r\n            The Aged Debtors report is used to view the amount of money that you owe to, or are owed by, your customers (also known as debtors) until a specific date.\r\n            It will display the current balance you owe and also the historical balance over the last three months and beyond.","operationId":"AgedDebtorsReport_GetReportForUser","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"endDate","in":"query","description":"End date for the aged debtors report","required":true,"type":"string","format":"date-time"},{"name":"showBreakdown","in":"query","description":"Flag to indicate whether to show or hide breakdown.\r\n            Default is false. i.e., breakdown is not shown.","required":false,"type":"boolean"},{"name":"showCustomer","in":"query","description":"Flag to show/hide customer even when the total owed is 0 (Even though there are unpaid invoices).\r\n            Default is false","required":false,"type":"boolean"},{"name":"sortOrder","in":"query","description":"Sort order 0 = Asc,  1 = Desc","required":false,"type":"integer","format":"int32","enum":[0,1]},{"name":"SortBy","in":"query","description":"Sort by code or name 0 = Code,  1 = Name","required":false,"type":"integer","format":"int32","enum":[0,1]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.AgedDebtorsReport.AgedDebtorsReport"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/alert/{messageId}":{"put":{"tags":["AlertMessage"],"summary":"Mark an alert as read and get a list of unread alerts","operationId":"AlertMessage_HideNotificationMessage","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"messageId","in":"path","description":"Message Id to be marked as read","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Message"}}}},"deprecated":false}},"/internal/amazonfiles/migration":{"put":{"tags":["AmazonFile"],"summary":"Move files from Amazon to Dropbox","operationId":"AmazonFile_MigrateAmazonFiles","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"Moved files from Amazon to Dropbox"}},"deprecated":false}},"/api/settings/ipaddress":{"get":{"tags":["ApiSettings"],"summary":"Get the API settings","operationId":"ApiSettings_GetIPAddresses","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.IPAddress"}}}},"deprecated":false},"post":{"tags":["ApiSettings"],"summary":"Get the API settings","operationId":"ApiSettings_AddIPAddress","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"ipAddressRequest","in":"body","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.IPAddressBase"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.IPAddressBase"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/api/settings/ipaddress/{id}":{"delete":{"tags":["ApiSettings"],"summary":"Delete a restricted IP address","operationId":"ApiSettings_DeleteIPAddress","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The id of the restricted IP address to delete.","required":true,"type":"integer","format":"int32"}],"responses":{"204":{"description":"IP Address Deleted"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"IP Address Not Found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/sessiontoken":{"get":{"tags":["Authentication"],"summary":"This is only used for automatic login from sec.kf or any external link","operationId":"Authentication_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"externalToken","in":"query","description":"GUID","required":true,"type":"string"},{"name":"uid","in":"query","description":"t_user.uid","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Authentication.ExternTokenAuthenticationResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity Not Found"}},"deprecated":false},"put":{"tags":["Authentication"],"summary":"Generate a permanent token based on valid memorable word characters and a temporary token","operationId":"Authentication_Put","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"authRequest","in":"body","description":"Authentication details object","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Authentication.PermanentTokenAuthenticationDetailsRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Authentication.PermanentTokenAuthenticationDetailsResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity Not Found"}},"deprecated":false},"post":{"tags":["Authentication"],"summary":"Send a request to get a temporary token","operationId":"Authentication_Post","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"authRequest","in":"body","description":"CompanyName Username and Password","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Authentication.AuthenticationDetailsRequest"}},{"name":"oldApp","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"201":{"description":"Get Temporary Token","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Authentication.AuthenticationDetailsResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity Not Found"}},"deprecated":false}},"/sessiontoken/{id}":{"get":{"tags":["Authentication"],"summary":"Create Permanent link","operationId":"Authentication_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"ID of the company to create token for","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Authentication.CompanyIdAuthenticationResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity Not Found"}},"deprecated":false}},"/sessiontoken/{sessionToken}":{"delete":{"tags":["Authentication"],"summary":"Delete the session token","operationId":"Authentication_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"sessionToken","in":"path","description":"Session Token","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity Not Found"}},"deprecated":false}},"/sessiontoken/mobile":{"post":{"tags":["Authentication"],"summary":"Create KF session token for mobile user.","operationId":"Authentication_CreateKFSessionToken","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/sessiontoken/dext/{oauthToken}":{"get":{"tags":["Authentication"],"summary":"Verify the user logged is valid for the given dext token","operationId":"Authentication_VerifyDextToken","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"oauthToken","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/backup/{backupNumber}":{"get":{"tags":["Backup"],"summary":"Download the back up file","operationId":"Backup_file","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"backupNumber","in":"path","description":"backupNumber to download the file","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/reports/balancesheet":{"get":{"tags":["BalanceSheetReport"],"operationId":"BalanceSheetReport_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"endDate","in":"query","required":true,"type":"string","format":"date-time"},{"name":"startDate","in":"query","required":false,"type":"string","format":"date-time"},{"name":"excludeZeroBalance","in":"query","required":false,"type":"boolean"},{"name":"showBreakdown","in":"query","required":false,"type":"boolean"},{"name":"accountingType","in":"query","description":" 0 = Cash,  1 = Accrual","required":false,"type":"integer","format":"int32","enum":[0,1]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.BalanceSheetReport.BalanceSheetReport"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/bankaccounts/suggestedcode":{"get":{"tags":["BankAccount"],"summary":"Get the next available bank code for the bank account. This is used to populate the Code field on the Create Bank Account screen","operationId":"BankAccount_GetSuggestedCode","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"format":"int32","type":"integer"}},"401":{"description":"Unauthorized Access ","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/bankaccounts":{"get":{"tags":["BankAccount"],"summary":"Get bank accounts list for user","operationId":"BankAccount_GetList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"includeArchivedAccounts","in":"query","description":"Include Archived Accounts","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.BankAccount.BankAccountListResponse"}}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["BankAccount"],"summary":"Create a new bank account","operationId":"BankAccount_Create","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"bankAccountRequest","in":"body","description":"Bank account details","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.BankAccount.BankAccountRequest"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.BankAccount.BankAccountResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/bankaccounts/list":{"get":{"tags":["BankAccount"],"summary":"Get paginated list of user bank accounts","operationId":"BankAccount_GetList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"page","in":"query","description":"Page number. (default is 1)","required":false,"type":"integer","format":"int32"},{"name":"perpage","in":"query","description":"PerPage is number of records per page. (default is 1000)","required":false,"type":"integer","format":"int32"},{"name":"order","in":"query","description":"In what order to sort the list","required":false,"type":"string"},{"name":"includemonthlystats","in":"query","description":"Flag to include/exclude bank account`s monthly statistics","required":false,"type":"boolean"},{"name":"includearchivedaccounts","in":"query","description":"Flag to include/exclude archived bank accounts","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Paging[KashFlow.Accounting.DTO.BankAccount.BankAccountListResponse]"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/bankaccounts/{id}":{"get":{"tags":["BankAccount"],"summary":"Get a list of user bank accounts, by ID","operationId":"BankAccount_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"Bank account Id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.BankAccount.BankAccountResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Not Found"}},"deprecated":false},"put":{"tags":["BankAccount"],"summary":"Update the user bank account details, by ID","operationId":"BankAccount_Update","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"Bank account Id","required":true,"type":"integer","format":"int32"},{"name":"bankAccountRequest","in":"body","description":"Bank account details that need to be updated","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.BankAccount.BankAccountUpdateRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.BankAccount.BankAccountResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Not Found"}},"deprecated":false},"delete":{"tags":["BankAccount"],"summary":"Delete the user bank account, by ID","operationId":"BankAccount_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"Bank account Id to be deleted","required":true,"type":"integer","format":"int32"}],"responses":{"204":{"description":"Bankaccount deleted"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No Bankaccount found with that id"}},"deprecated":false}},"/bankaccounts/bank-order":{"put":{"tags":["BankAccount"],"summary":"Update bank account order","operationId":"BankAccount_Update","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"bankAccountRequest","in":"body","description":"Bank account request","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.BankAccountListRequest"}}}],"responses":{"200":{"description":"Bank account order has been updated"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/bankaccounts/feeds":{"post":{"tags":["BankAccount"],"summary":"Register the user for bank feeds","operationId":"BankAccount_RegisterBankFeeds","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"feedSourceProvider","in":"query","description":"Transactions are to be created on BankFeed","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"delete":{"tags":["BankAccount"],"summary":"Remove user from bank feeds","operationId":"BankAccount_UnegisterBankFeeds","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"204":{"description":"Unregistered the BankFeeds"}},"deprecated":false}},"/bankaccounts/{accountid}":{"put":{"tags":["BankAccount"],"summary":"Associate bank account with KashFlow bank account","operationId":"BankAccount_AttachBankFeed","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountid","in":"path","description":"KashFlow bank account ID","required":true,"type":"integer","format":"int32"},{"name":"attachFeedAccount","in":"query","description":"Corresponding bank feed account ID","required":true,"type":"integer","format":"int32"},{"name":"feedSiteName","in":"query","required":true,"type":"string"},{"name":"feedAccountName","in":"query","required":true,"type":"string"},{"name":"feedAccountNumber","in":"query","required":true,"type":"string"},{"name":"feedAccountHolder","in":"query","required":true,"type":"string"},{"name":"feedSource","in":"query","required":false,"type":"string"}],"responses":{"204":{"description":"Attached bank feeds account with the KashFlow bank account"}},"deprecated":false}},"/bankaccounts/{BankAccountId}/bankfeeds":{"post":{"tags":["BankAccount"],"summary":"Create a bank feed account","operationId":"BankAccount_CreateBankFeedsAccount","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"BankAccountId","in":"path","description":"This is KashFlow Bank Account ID","required":true,"type":"integer","format":"int32"},{"name":"bankfeedSource","in":"body","description":"Transactions are to be created on BankFeed","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"BankFeed account created"}},"deprecated":false}},"/bankfeeds":{"get":{"tags":["BankFeed"],"summary":"Get a list of bank feeds","operationId":"BankFeed_GetListOfBankFeeds","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/bankfeeds/{BankFeedsAccountId}":{"get":{"tags":["BankFeed"],"summary":"Get a list of bank feeds by account ID","operationId":"BankFeed_GetBankFeed","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"BankFeedsAccountId","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/bankfeeds/{BankFeedsAccountId}/transactions":{"get":{"tags":["BankFeed"],"summary":"Get a list of bank feed transactions by account ID","operationId":"BankFeed_GetBankFeedAccountTransactions","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"BankFeedsAccountId","in":"path","description":"","required":true,"type":"integer","format":"int32"},{"name":"startDate","in":"query","description":"","required":false,"type":"string"},{"name":"endDate","in":"query","description":"","required":false,"type":"string"},{"name":"page","in":"query","description":"","required":false,"type":"integer","format":"int32"},{"name":"perpage","in":"query","description":"","required":false,"type":"integer","format":"int32"},{"name":"sortcolumn","in":"query","description":"","required":false,"type":"string"},{"name":"order","in":"query","description":"","required":false,"type":"string"},{"name":"batch","in":"query","description":"","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false},"delete":{"tags":["BankFeed"],"summary":"Delete the bank feed transactions linked to the KashFlow Bank Account ID","operationId":"BankFeed_DeleteBankFeedAccountTransactions","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"BankFeedsAccountId","in":"path","description":"","required":true,"type":"integer","format":"int32"},{"name":"batch","in":"query","description":"","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/bankfeeds/{bankFeedsAccountId}/transactions/{transactionId}":{"get":{"tags":["BankFeed"],"summary":"Get a list of bank feed transactions by transaction ID","operationId":"BankFeed_GetBankFeedAccountTransaction","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"bankFeedsAccountId","in":"path","description":"","required":true,"type":"integer","format":"int32"},{"name":"transactionId","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false},"delete":{"tags":["BankFeed"],"summary":"Delete the bank feed transactions linked to the KashFlow Bank Account ID, by account ID","operationId":"BankFeed_DeleteBankFeedAccountTransaction","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"bankFeedsAccountId","in":"path","description":"","required":true,"type":"integer","format":"int32"},{"name":"transactionId","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/bankfeeds/{BankFeedAccountId}/transactions":{"post":{"tags":["BankFeed"],"summary":"Create bank feed transactions and link to the KashFlow Bank Account ID","operationId":"BankFeed_CreateBankFeedsTransactions","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"BankFeedAccountId","in":"path","description":"This is Bank feed Account ID","required":true,"type":"integer","format":"int32"},{"name":"transactions","in":"body","description":"Transactions are to be created on BankFeed","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.BankFeed.BankFeedTransaction"}}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/bankfeeds/{bankFeedAccountId}/transactions/file":{"post":{"tags":["BankFeed"],"summary":"Create a file of the bank feed transactions linked to the KashFlow Bank Account ID","operationId":"BankFeed_CreateBankFeedsTransactions","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"bankFeedAccountId","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/bankicons":{"get":{"tags":["BankIcon"],"summary":"Get list of bank icons","operationId":"BankIcon_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/bankaccounts/{bankaccountId}/reconciliations/metadata":{"get":{"tags":["BankReconciliation"],"summary":"Get the next reconciliation start date and start balance for the bank account, by ID","operationId":"BankReconciliation_GetMetadata","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"bankaccountId","in":"path","description":"BankaccountId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.BankReconciliation.BankReconciliationDetails"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/bankaccounts/{bankaccountId}/reconciliations":{"get":{"tags":["BankReconciliation"],"summary":"Get a list of bank reconciliations for the bank account ID","operationId":"BankReconciliation_GetPage","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"bankaccountId","in":"path","description":"BankaccountId","required":true,"type":"integer","format":"int32"},{"name":"page","in":"query","description":"page number","required":false,"type":"integer","format":"int32"},{"name":"perPage","in":"query","description":"page size","required":false,"type":"integer","format":"int32"},{"name":"sortOrder","in":"query","description":"sort order 0 = Asc,  1 = Desc","required":false,"type":"integer","format":"int32","enum":[0,1]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Paging[KashFlow.Accounting.DTO.BankReconciliation.BankReconciliationResponse]"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["BankReconciliation"],"summary":"Create a bank reconciliation","operationId":"BankReconciliation_Create","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"bankaccountId","in":"path","description":"BankaccountId","required":true,"type":"integer","format":"int32"},{"name":"bankReconciliationBase","in":"body","description":"Reconciliation Details","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Base.BankReconciliationBase"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.BankReconciliation.BankReconciliationDetailedResponse"}},"201":{"description":"Created","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.BankReconciliation.BankReconciliationDetailedResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/bankaccounts/{bankaccountId}/reconciliations/{reconciliationId}":{"get":{"tags":["BankReconciliation"],"summary":"Get bank reconciliation details, by ID","operationId":"BankReconciliation_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"bankaccountId","in":"path","description":"BankaccountId","required":true,"type":"integer","format":"int32"},{"name":"reconciliationId","in":"path","description":"ReconciliationId","required":true,"type":"integer","format":"int32"},{"name":"excludetransactions","in":"query","description":"Excludetransactions","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.BankReconciliation.BankReconciliationDetailedResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"put":{"tags":["BankReconciliation"],"summary":"Update an existing bank reconciliation, by ID","operationId":"BankReconciliation_Update","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"bankaccountId","in":"path","description":"BankaccountId","required":true,"type":"integer","format":"int32"},{"name":"reconciliationId","in":"path","description":"ReconciliationId","required":true,"type":"integer","format":"int32"},{"name":"bankReconciliationRequest","in":"body","description":"reconciliation Details","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.BankReconciliation.BankReconciliationRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.BankReconciliation.BankReconciliationDetailedResponse"}},"201":{"description":"Created","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.BankReconciliation.BankReconciliationDetailedResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"delete":{"tags":["BankReconciliation"],"summary":"Delete the bank reconciliation, by ID","operationId":"BankReconciliation_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"bankaccountId","in":"path","description":"BankaccountId","required":true,"type":"integer","format":"int32"},{"name":"reconciliationId","in":"path","description":"ReconciliationId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"Reconciliation deleted"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/bankaccounts/{bankaccountId}/reconciliations/{reconciliationId}/transactions":{"put":{"tags":["BankReconciliation"],"summary":"Update transactions on the bank reconciliation","operationId":"BankReconciliation_UpdateTransactionReconcilationStatus","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"bankaccountId","in":"path","description":"BankaccountId","required":true,"type":"integer","format":"int32"},{"name":"reconciliationId","in":"path","description":"ReconciliationId","required":true,"type":"integer","format":"int32"},{"name":"reconcilationItemsRequest","in":"body","description":"transactions Details","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.BankReconciliation.ReconcilationItemsRequest"}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.BankReconciliationTransaction"}}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/bankaccounts/{accountId}/transactions":{"get":{"tags":["BankTransaction"],"summary":"Get the bank transaction list, by bank account ID","operationId":"BankTransaction_GetPage","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"Account Id to retrieve transactions for","required":true,"type":"integer","format":"int32"},{"name":"page","in":"query","description":"Page number. (default is 1)","required":false,"type":"integer","format":"int32"},{"name":"perpage","in":"query","description":"PerPage is number of records per page. (default is 10)","required":false,"type":"integer","format":"int32"},{"name":"startdate","in":"query","description":"Optional. If set, only transactions with date starting from this day will be returned","required":false,"type":"string"},{"name":"enddate","in":"query","description":"Optional. If set, only transactions with date before on this day will be returned","required":false,"type":"string"},{"name":"sortcolumn","in":"query","description":"By what to sort the list 1 = Date,  2 = PaidIn,  3 = PaidOut,  4 = TransactionType,  5 = Comment,  6 = Name","required":false,"type":"integer","format":"int32","enum":[1,2,3,4,5,6]},{"name":"order","in":"query","description":"In what order to sort the list","required":false,"type":"string"},{"name":"filterby","in":"query","description":"Status Filter","required":false,"type":"string"},{"name":"includebulk","in":"query","description":"Whether to include bulk","required":false,"type":"boolean"},{"name":"searchtext","in":"query","description":"Filter by text","required":false,"type":"string"},{"name":"includefeedmatched","in":"query","description":"Whether to include matched feed","required":false,"type":"boolean"},{"name":"includejournals","in":"query","description":"&gt;Whether to include journal","required":false,"type":"boolean"},{"name":"includenominalcodebanktransactions","in":"query","description":"Whether to include Bank transactions of money type","required":false,"type":"boolean"},{"name":"reconciled","in":"query","description":"Whether to return reconciled or unreconciled transactions. Passing null disabled this filter","required":false,"type":"boolean"},{"name":"iscsv","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Paging[KashFlow.Accounting.DTO.BankTransaction.BankTransactionListResponse,KashFlow.Accounting.Model.BankTransactionPagingMetadata]"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["BankTransaction"],"summary":"Create a bank transaction","operationId":"BankTransaction_Create","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"AccountId","required":true,"type":"integer","format":"int32"},{"name":"bankTransactionRequest","in":"body","description":"Transaction Details","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.BankTransaction.BankTransactionRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.BankTransaction.BankTransactionDetailedResponse"}},"201":{"description":"transaction added","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.BankTransaction.BankTransactionDetailedResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/bankaccounts/{accountId}/transactions/{transactionId}":{"get":{"tags":["BankTransaction"],"summary":"Get the bank transaction details. by account ID","operationId":"BankTransaction_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"AccountId","required":true,"type":"integer","format":"int32"},{"name":"transactionId","in":"path","description":"TransactionId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.BankTransaction.BankTransactionDetailedResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"put":{"tags":["BankTransaction"],"summary":"Update an existing bank transaction, by ID","operationId":"BankTransaction_Update","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"AccountId","required":true,"type":"integer","format":"int32"},{"name":"transactionId","in":"path","description":"TransactionId","required":true,"type":"integer","format":"int64"},{"name":"bankTransactionRequest","in":"body","description":"transaction details","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.BankTransaction.BankTransactionDetailRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.BankTransaction.BankTransactionDetailedResponse"}},"201":{"description":"transaction updated","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.BankTransaction.BankTransactionDetailedResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"delete":{"tags":["BankTransaction"],"summary":"Delete a bank transaction, by ID","operationId":"BankTransaction_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"Accound Id of transaction","required":true,"type":"integer","format":"int32"},{"name":"transactionId","in":"path","description":"ID of the transaction","required":true,"type":"integer","format":"int32"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/bankaccounts/{accountId}/transactionlist":{"put":{"tags":["BankTransaction"],"summary":"Assign bank transactions to invoices and purchases and then delete the bank transaction","operationId":"BankTransaction_AssignTransactionToPayment","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"Bank account id","required":true,"type":"integer","format":"int32"},{"name":"bankTransactionBulkAssignRequest","in":"body","description":"list of bank transaction with conversion info.","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.BankTransaction.BankTransactionBulkAssignRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.BankTransactionBulkAssign"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"delete":{"tags":["BankTransaction"],"summary":"Bulk delete bank transactions","operationId":"BankTransaction_DeleteBankTransaction","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"Bank account id","required":true,"type":"integer","format":"int32"},{"name":"transactionIds","in":"body","description":"List of transaction ids","required":true,"schema":{"type":"array","items":{"format":"int32","type":"integer"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Base.BankTransactionMassDeleteStatus"}}},"204":{"description":"No Content"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/bankaccounts/assign-transaction-to-new-entity":{"post":{"tags":["BankTransaction"],"summary":"Create bank transactions to invoices and purchases and then delete the bank transaction","operationId":"BankTransaction_ConvertBankTransactionToEntity","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"bankTransactionBulkCreateRequest","in":"body","description":"list of bank createEntityRequest with conversion info.","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Bank.CreateToEntityWrapper"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Bank.EntityMassCreateStatus"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/bankaccounts/{accountId}/transactions/bfs":{"get":{"tags":["BankTransaction"],"summary":"Get a list of transactions, imported via bank feeds","operationId":"BankTransaction_GetBankTransaction","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"AccountId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"format":"int64","type":"integer"}}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/bankaccounts/{accountId}/transactions/bfstransactions":{"get":{"tags":["BankTransaction"],"summary":"Get details of the transaction list, imported via bank feeds","operationId":"BankTransaction_GetDetailedBankTransaction","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"AccountId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.BankTransaction.BankFeedTransactionResponse"}}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/branding":{"get":{"tags":["Branding"],"summary":"Gets the user branding setting set by their partner.","operationId":"Branding_GetBrandingSettings","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.BrandingSettings"}}},"deprecated":false}},"/documents/invoice/bulk":{"post":{"tags":["BulkDocument"],"summary":"Generate a link to view a PDF copy of multiple invoices","operationId":"BulkDocument_Post","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"invoiceNumbers","in":"body","description":"","required":true,"schema":{"type":"array","items":{"format":"int32","type":"integer"}}},{"name":"order","in":"query","description":"","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/documents/customerstatement/bulk":{"post":{"tags":["BulkDocument"],"summary":"Generate a link to get a statement for multiple customers","operationId":"BulkDocument_Post","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"customerCodes","in":"body","description":"","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/documents/supplierstatement/bulk":{"post":{"tags":["BulkDocument"],"summary":"Generate a link to get a statement for multiple suppliers","operationId":"BulkDocument_CreateSupplierStatement","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"supplierCodes","in":"body","description":"","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/documents/purchase/bulk":{"post":{"tags":["BulkDocument"],"summary":"Generate a link to view a PDF copy of multiple purchase invoices","operationId":"BulkDocument_CreatePurchaseInvoice","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"purchaseInvoiceNumbers","in":"body","description":"","required":true,"schema":{"type":"array","items":{"format":"int32","type":"integer"}}},{"name":"order","in":"query","description":"","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/documents/purchasebatchpayment/bulk":{"post":{"tags":["BulkDocument"],"summary":"Generate a link to view a PDF copy of purchase batch payment","operationId":"BulkDocument_CreatePurchaseInvoice","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"batchPaymentNumber","in":"query","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/invoices/bulk/email":{"post":{"tags":["BulkEmail"],"summary":"Send multiple invoices via email","operationId":"BulkEmail_SendInvoiceBulkEmail","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"invoiceNumbers","in":"body","description":"","required":true,"schema":{"type":"array","items":{"format":"int32","type":"integer"}}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/customerstatements/bulk/email":{"post":{"tags":["BulkEmail"],"summary":"Send multiple customer statements via email","operationId":"BulkEmail_SendCustomerStatementBulkEmail","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"customerCodes","in":"body","description":"Customer code","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"startdate","in":"query","description":"Start date YYYYMMDD","required":false,"type":"integer","format":"int32"},{"name":"enddate","in":"query","description":"End date YYYYMMDD","required":false,"type":"integer","format":"int32"},{"name":"excludepaidinvoices","in":"query","description":"Paid invoice (0/1)","required":false,"type":"integer","format":"int32"},{"name":"excludeOpeningBalance","in":"query","description":"Whether to exclude opening balance in statement or not","required":false,"type":"integer","format":"int32"},{"name":"filterby","in":"query","description":"If dates are not provided then provide filterBy as all","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/supplierstatements/bulk/email":{"post":{"tags":["BulkEmail"],"summary":"Send multiple supplier statements via email","operationId":"BulkEmail_SendSupplierStatementBulkEmail","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"supplierCodes","in":"body","description":"","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"startdate","in":"query","description":"","required":false,"type":"integer","format":"int32"},{"name":"enddate","in":"query","description":"","required":false,"type":"integer","format":"int32"},{"name":"excludepaidpurchases","in":"query","description":"","required":false,"type":"integer","format":"int32"},{"name":"excludeOpeningBalance","in":"query","description":"","required":false,"type":"integer","format":"int32"},{"name":"filterby","in":"query","description":"","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/InvoicePayment/bulk/email":{"post":{"tags":["BulkEmail"],"summary":"Send multiple customer statements via email","operationId":"BulkEmail_SendInvoicePaymentBulkEmail","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"batchPaymentId","in":"query","description":"Batch Payment Id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/purchase/bulk/email":{"post":{"tags":["BulkEmail"],"summary":"Send multiple invoices via email","operationId":"BulkEmail_SendPurchaseBulkEmail","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"purchaseNumbers","in":"body","description":"","required":true,"schema":{"type":"array","items":{"format":"int32","type":"integer"}}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/PurchasePayment/bulk/email":{"post":{"tags":["BulkEmail"],"summary":"Send multiple supplier statements via email","operationId":"BulkEmail_SendPurchasePaymentBulkEmail","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"batchPaymentNumber","in":"query","description":"Batch Payment Number","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/{objectType}/bulk/payments/{number}":{"get":{"tags":["BulkPayment"],"summary":"Get a payment for multiple invoices or purchases","operationId":"BulkPayment_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"objectType","in":"path","description":"","required":true,"type":"string"},{"name":"number","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false},"put":{"tags":["BulkPayment"],"summary":"Edit a payment for multiple invoices or purchases","operationId":"BulkPayment_Update","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"objectType","in":"path","description":"","required":true,"type":"string"},{"name":"number","in":"path","description":"","required":true,"type":"integer","format":"int32"},{"name":"bulkPayment","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Payment.BulkPayment"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false},"delete":{"tags":["BulkPayment"],"summary":"Delete a payment for multiple invoices or purchases","operationId":"BulkPayment_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"objectType","in":"path","description":"","required":true,"type":"string"},{"name":"number","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/{objectType}/bulk/payments":{"post":{"tags":["BulkPayment"],"summary":"Create a payment for multiple invoices or purchases","operationId":"BulkPayment_Create","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"objectType","in":"path","description":"","required":true,"type":"string"},{"name":"bulkPayment","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Payment.BulkPayment"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/reports/business/activity":{"get":{"tags":["BusinessReport"],"summary":"Get the activity report","operationId":"BusinessReport_GetActivityReport","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"includetransactions","in":"query","description":" 0 = SalesPurchases,  1 = Sales,  2 = Purchases","required":false,"type":"integer","format":"int32","enum":[0,1,2]},{"name":"basedon","in":"query","description":" 0 = All,  1 = PaidOnly","required":false,"type":"integer","format":"int32","enum":[0,1]},{"name":"showvatrelatedinformation","in":"query","required":false,"type":"boolean"},{"name":"showfullcustomersuppliername","in":"query","required":false,"type":"boolean"},{"name":"sortby","in":"query","description":" 0 = PaidDate,  1 = Date,  2 = Number,  3 = Reference,  4 = Code,  5 = Name,  6 = Nominal,  7 = Note,  8 = MoneyIn,  9 = MoneyOut,  10 = InputVat,  11 = OutputVat","required":false,"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,9,10,11]},{"name":"orderby","in":"query","required":false,"type":"string"},{"name":"pagenumber","in":"query","required":false,"type":"integer","format":"int32"},{"name":"perpage","in":"query","required":false,"type":"integer","format":"int32"},{"name":"startdate","in":"query","required":true,"type":"string"},{"name":"enddate","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.ActivityReport.ActivityReportResponse"}}}},"deprecated":false}},"/reports/business/audit/users":{"get":{"tags":["BusinessReport"],"summary":"Get the audit report users","operationId":"BusinessReport_GetAuditReportUsers","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"startDate","in":"query","description":"Start Date","required":true,"type":"string"},{"name":"endDate","in":"query","description":"End Date","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"type":"string"}}}},"deprecated":false}},"/reports/business/audit":{"get":{"tags":["BusinessReport"],"summary":"Get the audit report","operationId":"BusinessReport_GetAuditReport","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"transactionbasedon","in":"query","description":" 0 = SpecificTransaction,  1 = TransactionBetweenDates,  2 = TransactionCreatedOrEditedOrDeletedBetweenDates","required":false,"type":"integer","format":"int32","enum":[0,1,2]},{"name":"transactionnumber","in":"query","required":false,"type":"integer","format":"int32"},{"name":"includesalesinvoices","in":"query","required":false,"type":"boolean"},{"name":"includesalesinvoicepayments","in":"query","required":false,"type":"boolean"},{"name":"includepurchaseinvoices","in":"query","required":false,"type":"boolean"},{"name":"includepurchaseinvoicepayments","in":"query","required":false,"type":"boolean"},{"name":"includebanktransactions","in":"query","required":false,"type":"boolean"},{"name":"includejournal","in":"query","required":false,"type":"boolean"},{"name":"includedeleteditems","in":"query","required":false,"type":"boolean"},{"name":"username","in":"query","required":false,"type":"string"},{"name":"created","in":"query","required":false,"type":"boolean"},{"name":"page","in":"query","required":false,"type":"integer","format":"int32"},{"name":"perpage","in":"query","required":false,"type":"integer","format":"int32"},{"name":"order","in":"query","required":false,"type":"string"},{"name":"sortby","in":"query","description":" 0 = CreatedDate,  1 = Date,  2 = TransactionNumber,  3 = Type,  4 = Reference,  5 = Value,  6 = Narrative,  7 = TaxRate,  8 = InputTax,  9 = OutputTax,  10 = NominalCode,  11 = Changes,  12 = UserName,  13 = EntityNumber","required":false,"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,13]},{"name":"startdate","in":"query","required":true,"type":"string"},{"name":"enddate","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Paging[KashFlow.Accounting.Model.Reports.AuditReport.AuditReportResponse]"}}},"deprecated":false}},"/reports/business/audit/{transactionNumber}":{"get":{"tags":["BusinessReport"],"summary":"Get the audit report based on transaction number","operationId":"BusinessReport_GetAuditReportHistory","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"transactionNumber","in":"path","description":"Transaction number","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Paging[KashFlow.Accounting.Model.Reports.AuditReport.AuditReportResponse]"}}},"deprecated":false}},"/reports/business/historicsalesandexpenditure":{"get":{"tags":["BusinessReport"],"summary":"Get historic sales and expenditure report","operationId":"BusinessReport_GetHistoricSalesAndExpenditure","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"startDate","in":"query","description":"Format: yyyy-MM-dd","required":true,"type":"string"},{"name":"endDate","in":"query","description":"Format: yyyy-MM-dd","required":true,"type":"string"},{"name":"includeJournals","in":"query","description":"Include journal entries","required":true,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.HistoricSalesAndExpenditureReport.HistoricSalesAndExpenditureReportResponse"}}}},"deprecated":false}},"/reports/business/stockoverview":{"get":{"tags":["BusinessReport"],"summary":"Get stock overview report","operationId":"BusinessReport_GetStockOverview","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"ordersOnly","in":"query","description":"Only show items where you have pending orders / deliveries","required":true,"type":"boolean"},{"name":"alertsOnly","in":"query","description":"Only include items where the quantity currently in stock is below the value set for \"Alert me if Qty drops below\"","required":true,"type":"boolean"},{"name":"excludeOrdered","in":"query","description":"Exclude items that are below the alert threshold, but the quantity currently pending delivery will bring it above that level - To be considered only when Alerts only is true","required":true,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.StockOverviewReport.StockOverviewReportResponse"}}},"deprecated":false}},"/reports/business/globalproject":{"get":{"tags":["BusinessReport"],"summary":"Get global project report","operationId":"BusinessReport_GetGlobalProjectReport","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"projects","in":"query","description":" 0 = Completed,  1 = Active,  2 = Archived,  -1 = All","required":true,"type":"integer","format":"int32","enum":[0,1,2,-1]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.GlobalProjectReport.GlobalProjectReportResponse"}}}},"deprecated":false}},"/reports/business/businessprogresssummary":{"get":{"tags":["BusinessReport"],"summary":"Get business progress summary report","operationId":"BusinessReport_GetBusinessProgressSummaryReport","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"basedon","in":"query","description":" 0 = Cash,  1 = Invoice","required":false,"type":"integer","format":"int32","enum":[0,1]},{"name":"startdate","in":"query","required":true,"type":"string"},{"name":"enddate","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.BusinessReport.BusinessProgressSummaryReport.BusinessProgressSummaryResponse"}}},"deprecated":false}},"/reports/business/digita-export":{"get":{"tags":["BusinessReport"],"summary":"Get Digita Exports Report","operationId":"BusinessReport_GetDigitaExportsReport","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"startdate","in":"query","required":true,"type":"string"},{"name":"enddate","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.BusinessReport.DigitaExportsReportResponse"}}}},"deprecated":false}},"/reports/business/hsbc-factoring":{"get":{"tags":["BusinessReport"],"summary":"Get hsbc factoring details","operationId":"BusinessReport_GetHSBCFactoringReport","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"clientnumber","in":"query","required":false,"type":"string"},{"name":"password","in":"query","required":false,"type":"string"},{"name":"startdate","in":"query","required":true,"type":"string"},{"name":"enddate","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.HSBCFactoring.HsbcFactoringResponse"}}},"deprecated":false}},"/reports/business/prepayments-accruals":{"get":{"tags":["BusinessReport"],"summary":"Get prepayments and accruals report based on invoice or receipts","operationId":"BusinessReport_GetPrePaymentAndAccrualsReport","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"isbasedoninvoice","in":"query","required":false,"type":"boolean"},{"name":"startdate","in":"query","required":true,"type":"string"},{"name":"enddate","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.BusinessReport.PrePaymentsAccrualsResponse"}}}},"deprecated":false}},"/reports/business/prepayments-accruals-journals-preview":{"get":{"tags":["BusinessReport"],"summary":"Get Journals Preview","operationId":"BusinessReport_GetJournalsPreviewForPrePaymentsAndAccrualsReport","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"lineids","in":"query","required":false,"type":"string"},{"name":"nominalcode","in":"query","required":false,"type":"integer","format":"int32"},{"name":"periodtype","in":"query","description":" 0 = Days,  1 = Months","required":false,"type":"integer","format":"int32","enum":[0,1]},{"name":"period","in":"query","required":false,"type":"integer","format":"int32"},{"name":"startdate","in":"query","required":false,"type":"string"},{"name":"installments","in":"query","required":false,"type":"integer","format":"int32"},{"name":"isreceipt","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.BusinessReport.JournalsPreviewResponse"}}}},"deprecated":false}},"/reports/business/prepayments-accruals-journals-create":{"post":{"tags":["BusinessReport"],"summary":"Create journals for prepayment invoices/ purchases","operationId":"BusinessReport_CreateJournalsForPrePayments","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"lineids","in":"query","required":false,"type":"string"},{"name":"nominalcode","in":"query","required":false,"type":"integer","format":"int32"},{"name":"periodtype","in":"query","description":" 0 = Days,  1 = Months","required":false,"type":"integer","format":"int32","enum":[0,1]},{"name":"period","in":"query","required":false,"type":"integer","format":"int32"},{"name":"startdate","in":"query","required":false,"type":"string"},{"name":"installments","in":"query","required":false,"type":"integer","format":"int32"},{"name":"isreceipt","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}},"deprecated":false}},"/reports/business/health-check":{"get":{"tags":["BusinessReport"],"summary":"Get health check report - This report tells you how you compare to a number of measures to check the health of your business.","operationId":"BusinessReport_GetHealthCheckReport","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.BusinessReport.HealthCheckReportResponse"}}},"deprecated":false}},"/reports/business/cis-summary":{"get":{"tags":["BusinessReport"],"summary":"Get CIS Summary report.","operationId":"BusinessReport_GetCisSummary","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"entity","in":"query","description":" 0 = Sales,  1 = Purchases","required":false,"type":"integer","format":"int32","enum":[0,1]},{"name":"basedon","in":"query","description":" 0 = All,  1 = PaidOnly","required":false,"type":"integer","format":"int32","enum":[0,1]},{"name":"customercode","in":"query","required":false,"type":"string"},{"name":"suppliercode","in":"query","required":false,"type":"string"},{"name":"startdate","in":"query","required":true,"type":"string"},{"name":"enddate","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.BusinessReport.CISSummary.CisSummaryResponse"}}},"deprecated":false}},"/reports/business/sage/entity-count":{"get":{"tags":["BusinessReport"],"summary":"Get the number of customers and suppliers created in a period.","operationId":"BusinessReport_GetCustomerAndSupplierCount","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"startdate","in":"query","required":true,"type":"string"},{"name":"enddate","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.SageExport.SageEntityCount"}}},"deprecated":false}},"/reports/business/sage/audit-trail-transaction":{"get":{"tags":["BusinessReport"],"summary":"Get Audit Trail Transaction by period for Sage export report.","operationId":"BusinessReport_GetAuditTrailTransactionByPeriod","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"includepayments","in":"query","required":false,"type":"boolean"},{"name":"startdate","in":"query","required":true,"type":"string"},{"name":"enddate","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.BusinessReport.AuditTrailTransactionResponse"}}}},"deprecated":false}},"/sources":{"get":{"tags":["BusinessSources"],"summary":"Get a list of business sources","operationId":"BusinessSources_GetSourceList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"onlySources","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.CustomerSourceList"}}},"400":{"description":"BadRequest","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.CustomerSourceList"}}},"401":{"description":"Unauthorized Access"}},"deprecated":false}},"/sources/getSource":{"get":{"tags":["BusinessSources"],"summary":"Get source details, by name","operationId":"BusinessSources_GetSource","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"sourceName","in":"query","description":"Source Name to get source detail","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.CustomerSourceDetail"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.CustomerSourceDetail"}},"401":{"description":"Unauthorized Access"}},"deprecated":false}},"/sources/createSource":{"post":{"tags":["BusinessSources"],"summary":"Create source","operationId":"BusinessSources_CreateNewSource","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"customerSourceRequest","in":"body","description":"Source detail to save","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.CustomerSourceBase"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.CustomerSourceDetail"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.CustomerSourceDetail"}},"401":{"description":"Unauthorized Access"}},"deprecated":false}},"/sources/{id}":{"put":{"tags":["BusinessSources"],"summary":"Update a source","operationId":"BusinessSources_UpdateSource","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"},{"name":"customerSource","in":"body","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.CustomerSourceBase"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.CustomerSourceDetail"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.CustomerSourceDetail"}},"401":{"description":"Unauthorized Access"}},"deprecated":false}},"/sources/deleteSource":{"delete":{"tags":["BusinessSources"],"summary":"Delete source","operationId":"BusinessSources_DeleteSource","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"name","in":"query","description":"Source Name to delete source","required":true,"type":"string"}],"responses":{"204":{"description":"Source deleted"},"400":{"description":"Invalid parameter"},"401":{"description":"Unauthorized Access"}},"deprecated":false}},"/internal/cardlesspayments":{"post":{"tags":["CardlessPayment"],"summary":"Make a cardless payment","operationId":"CardlessPayment_Post","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"paymentDetails","in":"body","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Payment.CardlessPaymentDetails"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Response.CardlessPaymentDetailResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/internal/cardpayments":{"post":{"tags":["CardPayment"],"summary":"Make a card payment","operationId":"CardPayment_Post","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"paymentDetails","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Payment.PaymentDetails"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/internal/cardpayments/{processorType}":{"post":{"tags":["CardPayment"],"summary":"Receive a PCI payment","operationId":"CardPayment_ProcessorPCIPaymentAsync","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"paymentDetails","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Payment.PaymentDetails"}},{"name":"processorType","in":"path","description":" 0 = NoCardPayments,  1 = SecureHosting,  2 = SagePay,  3 = IridiumCorp,  4 = Worldpay,  5 = ProcessingPoint,  6 = SagePaymentSolutions,  7 = SmartPay,  8 = AuthorizeDotNet,  9 = PayPalPro,  10 = PaymentSense,  11 = CardSave,  12 = CardStream,  14 = BarclayCardEPdq,  15 = GoCardless,  16 = McpePayPoint,  17 = GlobalPayments,  18 = EWayPayment,  19 = Stripe,  20 = BarclayCardEPdqExtraPlus,  21 = Square,  22 = IRISPay","required":true,"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,14,15,16,17,18,19,20,21,22]}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Payment.CardPaymentResponse"}},"404":{"description":"No processor found with that name"}},"deprecated":false}},"/internal/cardpayments/{processorType}/refunds":{"post":{"tags":["CardPayment"],"summary":"Refund card payment for selected payment processor","operationId":"CardPayment_RefundPayment","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"refundRequest","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Payment.RefundRequest"}},{"name":"processorType","in":"path","description":" 0 = NoCardPayments,  1 = SecureHosting,  2 = SagePay,  3 = IridiumCorp,  4 = Worldpay,  5 = ProcessingPoint,  6 = SagePaymentSolutions,  7 = SmartPay,  8 = AuthorizeDotNet,  9 = PayPalPro,  10 = PaymentSense,  11 = CardSave,  12 = CardStream,  14 = BarclayCardEPdq,  15 = GoCardless,  16 = McpePayPoint,  17 = GlobalPayments,  18 = EWayPayment,  19 = Stripe,  20 = BarclayCardEPdqExtraPlus,  21 = Square,  22 = IRISPay","required":true,"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,14,15,16,17,18,19,20,21,22]}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Payment.CardPaymentResponse"}},"404":{"description":"No processor found with that name"}},"deprecated":false}},"/categories/list":{"put":{"tags":["Category"],"summary":"Update a quote category in a bulk","operationId":"Category_UpdateCategories","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"categories","in":"body","description":"List of Category to be updated","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Wrapper.CategoryWrapper"}}],"responses":{"200":{"description":"Updated Quote Categories"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["Category"],"summary":"Create bulk quote category","operationId":"Category_AddCategories","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"categories","in":"body","description":"The list of quote category to be created","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Wrapper.CategoryWrapper"}}],"responses":{"201":{"description":"Created Category"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/categories/{number}":{"delete":{"tags":["Category"],"summary":"Delete a category","operationId":"Category_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"Number","required":true,"type":"integer","format":"int32"},{"name":"entityType","in":"query","description":"entityType","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted Quote Category"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/categories/{entity}":{"get":{"tags":["Category"],"summary":"This API allows a developer to retrieve a list of categories available in specific IRIS KashFlow account.","operationId":"Category_GetList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"entity","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.CategoryRequest"}}},"401":{"description":"Unauthorized Access ","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/categoryicons":{"get":{"tags":["CategoryIcons"],"summary":"This API allows a developer to retrieve a list of categories icons available in IRIS KashFlow which you can use while creating or updating quote categories and purchase order categories.","operationId":"CategoryIcons_GetList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.CategoryIcon"}}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/settings/companydetails":{"get":{"tags":["CompanyDetails"],"summary":"Get the company details","operationId":"CompanyDetails_GetCompanyDetails","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.CompanyDetails.CompanyDetailsResponse"}}},"deprecated":false},"put":{"tags":["CompanyDetails"],"summary":"Update the company details","operationId":"CompanyDetails_PutCompanyDetails","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"companyDetailsRequest","in":"body","description":"Company details to be updated","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.CompanyDetails.CompanyDetailsRequest"}},{"name":"initializeNominalSet","in":"query","description":"Informs if the company details has been initialized for a new user and/or his chart has been set.","required":false,"type":"boolean"},{"name":"saveBusinessTypeOnly","in":"query","description":"The type of the business","required":false,"type":"boolean"},{"name":"addressChanged","in":"query","description":"Informs if the company address has been changed","required":false,"type":"boolean"}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.CompanyDetails.CompanyDetailsResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/settings/companydetails/industrysectors":{"get":{"tags":["CompanyDetails"],"summary":"Get the industry sector list","operationId":"CompanyDetails_GetIndustrySectorList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Settings.IndustrySectorList"}}}},"deprecated":false}},"/settings/companydetails/businesstypes":{"get":{"tags":["CompanyDetails"],"summary":"Get the business type list","operationId":"CompanyDetails_GetBusinessTypes","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Settings.BusinessType"}}}},"deprecated":false}},"/settings/companydetails/employeecountrange":{"get":{"tags":["CompanyDetails"],"summary":"Get the employee count range list","operationId":"CompanyDetails_GetEmployeeCountRange","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Settings.EmployeeCountRange"}}}},"deprecated":false}},"/companieshouse/companies":{"get":{"tags":["CompanyHouse"],"summary":"Get Company Details from Company House API","operationId":"CompanyHouse_GetCompanyHouseDetails","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"searchtext","in":"query","required":true,"type":"string"},{"name":"perpage","in":"query","required":false,"type":"integer","format":"int32"},{"name":"page","in":"query","required":false,"type":"integer","format":"int32"},{"name":"restrictions","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.CompanyHouse.CompanyHouseDetails"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/copy":{"post":{"tags":["CopyObject"],"summary":"Create the copy of object","operationId":"CopyObject_CreateCopy","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"sourceEntity","in":"query","description":"entity which will create copy from(source copy)","required":true,"type":"string"},{"name":"targetEntity","in":"query","description":"entity which will create copy to(target copy)","required":true,"type":"string"},{"name":"SourceId","in":"query","description":"source copy Id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"format":"int32","type":"integer"}}},"deprecated":false}},"/countries":{"get":{"tags":["Country"],"summary":"Get the country list","operationId":"Country_GetCountries","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Core.Model.Country"}}}},"deprecated":false}},"/countries/vatrates":{"get":{"tags":["CountryVatRate"],"summary":"Get a list of available VAT rates for different countries","operationId":"CountryVatRate_GetCountryListWithVatRates","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"date","in":"query","description":"","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/internal/{objectType}/{objectId}/credits":{"get":{"tags":["Credit"],"summary":"Get a list of available credits that apply to an entity (advance payment, over-payment and credit note)","operationId":"Credit_GetCreditList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"objectType","in":"path","description":"","required":true,"type":"string"},{"name":"objectId","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false},"post":{"tags":["Credit"],"summary":"Apply a credit to an entity (advance payment, over-payment and credit note)","operationId":"Credit_CreateAdvancePayment","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"objectType","in":"path","description":"","required":true,"type":"string"},{"name":"objectId","in":"path","description":"","required":true,"type":"integer","format":"int32"},{"name":"creditList","in":"body","description":"","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Internal.Credit"}}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/currencies":{"get":{"tags":["Currencies"],"summary":"Get the available currency list","operationId":"Currencies_GetList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Currency"}}}},"deprecated":false},"post":{"tags":["Currencies"],"summary":"Create a new Currency","operationId":"Currencies_Create","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"currency","in":"body","description":"currency details","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Currency"}}],"responses":{"201":{"description":"Currency created"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/currencies/list":{"get":{"tags":["Currencies"],"summary":"Get the configured currency list","operationId":"Currencies_GetCurrencies","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Base.CurrencyBase"}}}},"deprecated":false}},"/currencies/{code}":{"get":{"tags":["Currencies"],"summary":"Get currency details, by Code","operationId":"Currencies_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"code","in":"path","description":"Code of currency","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Currency"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No Currency found"}},"deprecated":false},"put":{"tags":["Currencies"],"summary":"Update currency details, by Code","operationId":"Currencies_Update","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"code","in":"path","description":"Code of currency","required":true,"type":"string"},{"name":"currency","in":"body","description":"currency details","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Currency"}}],"responses":{"200":{"description":"Currency updated"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No Currency found"}},"deprecated":false},"delete":{"tags":["Currencies"],"summary":"Delete a currency, by Code","operationId":"Currencies_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"code","in":"path","description":"Code of currency to be deleted","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"Currency deleted"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No Currency found"}},"deprecated":false}},"/customers":{"get":{"tags":["Customer"],"summary":"This API allows a developer to retrieve a list of customers available in specific IRIS KashFlow account.","operationId":"Customer_GetPage","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"page","in":"query","required":false,"type":"integer","format":"int32"},{"name":"perpage","in":"query","required":false,"type":"integer","format":"int32"},{"name":"order","in":"query","required":false,"type":"string"},{"name":"sortby","in":"query","description":" 0 = Name,  1 = Code,  3 = TotalPaidAmount,  4 = OutstandingBalance","required":false,"type":"integer","format":"int32","enum":[0,1,3,4]},{"name":"namestartswith","in":"query","required":false,"type":"string"},{"name":"filterarchived","in":"query","required":false,"type":"boolean"},{"name":"searchtext","in":"query","required":false,"type":"string"},{"name":"startcreationdate","in":"query","required":false,"type":"string"},{"name":"endcreationdate","in":"query","required":false,"type":"string"},{"name":"skipperpagevalidation","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Paging[KashFlow.Accounting.DTO.Customer.CustomerListResponse]"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["Customer"],"summary":"This API allows a developer to create a new customer.","operationId":"Customer_Create","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"customerRequest","in":"body","description":"Customer details","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Customer.CustomerRequest"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Customer.CustomerResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/customers/{code}":{"get":{"tags":["Customer"],"summary":"This API allows a developer to retrieve details for a particular customer with the given code.","operationId":"Customer_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"code","in":"path","description":"Customer Code. Unique code used to represent a customer in your system for which you want to retrieve","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Customer.CustomerResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No customer found with that code"}},"deprecated":false},"put":{"tags":["Customer"],"summary":"This API allows a developer to modify an existing customer with the given code.","operationId":"Customer_Update","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"code","in":"path","description":"Customer Code. Unique code used to represent a customer in your system for which you want to modify details. Customer with such code must exist in system.","required":true,"type":"string"},{"name":"customerRequest","in":"body","description":"Customer details","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Customer.CustomerRequest"}},{"name":"updateInvoicesAddress","in":"query","description":"Flag for updating invoice address","required":false,"type":"boolean"}],"responses":{"200":{"description":"Customer was updated","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Customer.CustomerResponse"}},"201":{"description":"Customer updated with new Code","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Customer.CustomerResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No customer found with that code"}},"deprecated":false},"delete":{"tags":["Customer"],"summary":"This API allows a developer to delete an existing customer with the given code.","operationId":"Customer_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"code","in":"path","description":"Unique code used to represent a customer which you want to delete","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"Customer deleted"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No customer found with that code"}},"deprecated":false}},"/customers/search":{"get":{"tags":["Customer"],"summary":"This API allows a developer to retrieve details for a particular customer with the given customer code or email or name.","operationId":"Customer_GetCustomerBySearch","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"searchBy","in":"query","description":"Specify how do you want to search the customers. Allowed values to search by are - code, email or name","required":true,"type":"string"},{"name":"searchText","in":"query","description":"Code of the customer if you opt to search by code, email of the customer if you opt to search by email or full or partial name of the customer if you opt to search by name","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/System.Collections.Generic.KeyValuePair[System.Int32,System.String]"}}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/customers/{code}/statistics":{"get":{"tags":["Customer"],"summary":"Get transaction statistics for a customer, by code","operationId":"Customer_GetStatistics","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"code","in":"path","description":"","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.CustomerStatistics"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No customer found with that code"}},"deprecated":false},"put":{"tags":["Customer"],"summary":"Refresh the transaction statistics for a customer, by code","operationId":"Customer_UpdateStatistics","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"code","in":"path","description":"Customer code","required":true,"type":"string"}],"responses":{"200":{"description":"Customer statistics updated"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No customer found with that code"}},"deprecated":false}},"/customers/statistics":{"get":{"tags":["Customer"],"summary":"Get transaction statistics for all customers","operationId":"Customer_GetCustomersStatistics","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.CustomersStatistics"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"put":{"tags":["Customer"],"summary":"Refresh the transaction statistics for all customers","operationId":"Customer_UpdateStatistics","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"Customer statistics updated"},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No customer found with that code"}},"deprecated":false}},"/customerlist":{"delete":{"tags":["Customer"],"summary":"Delete multiple customers, by code","operationId":"Customer_DeleteCustomers","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"customerCodes","in":"body","description":"list of customer Codes","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Deleted customers"},"400":{"description":"Invalid parameters","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.CustomerMassDeleteStatus"}}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/customers/suggestedcode":{"post":{"tags":["Customer"],"summary":"Generate a customer code, by name","operationId":"Customer_GetSuggestedCodeFromName","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"customer","in":"body","description":"Customer details","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Customer"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/customers/customerbulkinvoice":{"post":{"tags":["Customer"],"summary":"Get Multiple customers invoices, by Customer Codes","operationId":"Customer_GetCustomerBulkInvoiceDetails","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"customerCodes","in":"body","description":"list of customer Customer Codes","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Customers.CustomerBulkInvoiceDetails"}}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/customers/standing-order-mandate/{customerCode}":{"get":{"tags":["Customer"],"summary":"Get Standing Order Mandate details for respective customer","operationId":"Customer_GetStandingOrderMandate","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"customerCode","in":"path","description":"Customer code","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Customers.StandingOrderMandate"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No standing order mandate found"}},"deprecated":false}},"/customers/standing-order-mandate":{"put":{"tags":["Customer"],"summary":"update Standing Order Mandate details","operationId":"Customer_UpdateStandingOrderMandate","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"standingOrderMandate","in":"body","description":"standing order mandate details","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Customers.StandingOrderMandate"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No standing order mendate found"}},"deprecated":false}},"/customers/schedule-statement":{"post":{"tags":["Customer"],"summary":"Upsert schedule statement  details","operationId":"Customer_UpsertScheduleStatement","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"statementDetails","in":"body","description":"schedule customer statement  details","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Customers.ScheduleStatementInsertRequest"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No schedule statement found"}},"deprecated":false}},"/customers/schedule-statement/{customerCode}":{"get":{"tags":["Customer"],"summary":"Get schedule customer statement","operationId":"Customer_GetScheduleStatement","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"customerCode","in":"path","description":"customer code","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Customers.ScheduleStatement"}},"400":{"description":"Schedule statement does not exist for specified customer","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No schedule statement found"}},"deprecated":false},"delete":{"tags":["Customer"],"summary":"Delete schedule customer statement","operationId":"Customer_DeleteScheduleStatement","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"customerCode","in":"path","description":"customer code","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"400":{"description":"Schedule statement does not exist for specified customer","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No schedule statement found"}},"deprecated":false}},"/customers/confirm-to-delete":{"get":{"tags":["Customer"],"summary":"Validate multiple customers, by code","operationId":"Customer_ConfirmCustomersToDelete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"customerCodes","in":"query","description":"list of customer Codes","required":true,"type":"string"}],"responses":{"200":{"description":"Confirm customers to delete"},"400":{"description":"Invalid parameters","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.CustomerMassDeleteStatus"}}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/internal/customers/valid-email":{"post":{"tags":["Customer"],"summary":"Get customers with valid email","operationId":"Customer_GetCustomersByValidEmail","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"customersCode","in":"body","description":"The customerscode.","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No customer found with that code"}},"deprecated":false}},"/settings/customerandsupplier":{"get":{"tags":["CustomerAndSupplier"],"summary":"Get the customer and suppliers settings","operationId":"CustomerAndSupplier_GetCustomerAndSupplierSettings","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.CompanyDetails.CompanyDetailsResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"put":{"tags":["CustomerAndSupplier"],"summary":"Update the customer and suppliers settings","operationId":"CustomerAndSupplier_UpdateCustomerAndSupplierSettings","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"settings","in":"body","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Settings.CustomerAndSupplierSettings"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.CompanyDetails.CompanyDetailsResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/customers/{code}/transactions":{"get":{"tags":["CustomerTransaction"],"summary":"Get the customer transactions (invoice, quote, payment)","operationId":"CustomerTransaction_GetTransactions","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"code","in":"path","description":"The customer code.","required":true,"type":"string"},{"name":"page","in":"query","description":"The page number.","required":false,"type":"integer","format":"int32"},{"name":"perPage","in":"query","description":"The number of items per page.","required":false,"type":"integer","format":"int32"},{"name":"sortBy","in":"query","description":"The property to sort by. 0 = Number,  1 = Date,  2 = Project,  3 = Type,  4 = Reference,  5 = Amount,  6 = Status","required":false,"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6]},{"name":"order","in":"query","description":"The sort order. 0 = Asc,  1 = Desc","required":false,"type":"integer","format":"int32","enum":[0,1]},{"name":"typeFilterBy","in":"query","description":"The transaction filter by. 0 = Unknown,  1 = Invoice,  2 = Payment,  3 = Quote,  6 = CreditNote","required":false,"type":"integer","format":"int32","enum":[0,1,2,3,6]},{"name":"projectFilterBy","in":"query","description":"The project to filter by.","required":false,"type":"integer","format":"int32"},{"name":"statusFilterBy","in":"query","description":"The status to filter by.","required":false,"type":"string"},{"name":"startdate","in":"query","required":false,"type":"string"},{"name":"enddate","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Paging[KashFlow.Accounting.Model.CustomerTransaction]"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No customer found with that code"}},"deprecated":false}},"/customerstatementtransaction":{"get":{"tags":["CustomerTransaction"],"summary":"Get customer statement transaction","operationId":"CustomerTransaction_GetCustomerStatementTransaction","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"customerCode","in":"query","description":"Customer code","required":true,"type":"string"},{"name":"startDate","in":"query","description":"Start date YYYY/MM/DD","required":false,"type":"string"},{"name":"endDate","in":"query","description":"End date YYYY/MM/DD","required":false,"type":"string"},{"name":"excludePaidInvoices","in":"query","description":"Paid invoice (0/1)","required":false,"type":"integer","format":"int32"},{"name":"excludeOpeningBalance","in":"query","description":"Paid invoice (0/1)","required":false,"type":"integer","format":"int32"},{"name":"filterBy","in":"query","description":"If dates are not provided then provide filterBy as all","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/dashboard/widgetsbusiness":{"get":{"tags":["Dashboard"],"summary":"Get the current and pervious values for Revenue, cost of sales, expenses and cashflow for a given date range","operationId":"Dashboard_GetDashboardBusinessWidget","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"daterange","in":"query","description":"Date range for which data is to be retrieve (default is ThisMonth) 0 = ThisMonth,  1 = ThisYear,  2 = ThisAccountingPeriod","required":false,"type":"integer","format":"int32","enum":[0,1,2]}],"responses":{"200":{"description":"Dashboard business widgets layout","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Dashboard.DashboardBusinessWidget"}},"404":{"description":"No dashboard business widgets layout found"}},"deprecated":false}},"/dashboard/financialoverview":{"get":{"tags":["Dashboard"],"summary":"Get financial overview data (turnover, cost of sale, gross profit, expenditure, net profit)","operationId":"Dashboard_GetProfitAndLossSummary","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"range","in":"query","description":"","required":true,"type":"array","items":{"type":"integer","format":"int32"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/dashboard/salesoverview":{"get":{"tags":["Dashboard"],"summary":"Get the sales overview","operationId":"Dashboard_GetSalesOverview","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/dashboard/reporttype":{"post":{"tags":["Dashboard"],"summary":"Set the report graph to display on the Dashboard","operationId":"Dashboard_SetDashboardReportType","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"reportType","in":"query","description":" 0 = SalesGrowth,  1 = ProfitAndLoss,  2 = IncomeBySource,  3 = AgedCreditors,  4 = AgedDebtors,  5 = BalanceSheet,  6 = TrialBalance,  7 = NominalLedger,  8 = FixedAssetRegister,  -1 = Unknown","required":true,"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,-1]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/dashboard/widgetslayout":{"get":{"tags":["Dashboard"],"summary":"Gets the dashboard widgets layout","operationId":"Dashboard_GetWidgetsLayout","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"Dashboard widgets layout","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Dashboard.WidgetsLayout"}}},"deprecated":false},"put":{"tags":["Dashboard"],"summary":"Updates the dashboard widgets layout","operationId":"Dashboard_UpdateWidgetsLayout","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"widgetsLayout","in":"body","description":"the layout to be updated","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Dashboard.WidgetsLayout"}}],"responses":{"200":{"description":"Dashboard widgets layout updated","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Dashboard.WidgetsLayout"}},"400":{"description":"Widgets layout details either empty or not provided","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/dashboard/overview/notifications":{"get":{"tags":["DashboardOverview"],"summary":"Gets the alert notifications.","operationId":"DashboardOverview_GetNotificationMessages","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Message"}}}},"deprecated":false}},"/dashboard/overview/announcements":{"get":{"tags":["DashboardOverview"],"summary":"Gets announcement by partner.","operationId":"DashboardOverview_GetAnnouncement","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"Announcement returned successfully.","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Announcement"}},"404":{"description":"No announcement found."}},"deprecated":false}},"/dashboard/overview/referrals":{"get":{"tags":["DashboardOverview"],"summary":"Gets referral details when partner associated user.","operationId":"DashboardOverview_GetReferralDetails","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"Dashboard referral details returned successfully.","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Referral"}},"404":{"description":"No referral details found."}},"deprecated":false}},"/dashboard/overview/onboarders":{"get":{"tags":["DashboardOverview"],"summary":"Gets onboarder details.","operationId":"DashboardOverview_GetOnboarderDetails","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"Onboarder details returned successfully.","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Onboarder"}}},"deprecated":false}},"/dashboard/settings/display":{"get":{"tags":["DashboardSettings"],"summary":"Gets Dashboard display settings.","operationId":"DashboardSettings_GetDisplayOptions","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"Dashboard display settings returned successfully.","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Dashboard.DisplaySettings"}}},"deprecated":false}},"/dashboard/summary/quotes":{"get":{"tags":["DashboardSummary"],"summary":"Gets quotes summary.","operationId":"DashboardSummary_GetQuoteSummary","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"Quote summary returned successfully.","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.QuoteSummary"}}},"404":{"description":"No quotes summary found."}},"deprecated":false}},"/dashboard/summary/imports":{"get":{"tags":["DashboardSummary"],"summary":"Gets data import transactions summary.","operationId":"DashboardSummary_GetDataImports","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"Dashboard Data Import transactions summary returned successfully.","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.DataImport"}}}},"deprecated":false}},"/dashboard/summary/financial":{"get":{"tags":["DashboardSummary"],"summary":"Gets financial summary.","operationId":"DashboardSummary_GetFinancialSummary","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"Financial summary returned successfully.","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.FinancialSummary"}}},"deprecated":false}},"/dashboard/summary/inapppromotion":{"get":{"tags":["DashboardSummary"],"summary":"Get Unipaas InAppPromotion setting","operationId":"DashboardSummary_GetUnipaasInappPromotionSetting","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"Dashboard Unipaas InAppPromotion setting returned successfully.","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.InAppPromotion"}}},"deprecated":false}},"/dataimport":{"post":{"tags":["DataImport"],"summary":"Queue the Paypal data import","operationId":"DataImport_QueueDataImport","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"importDetails","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.DataImport"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/duplicate":{"post":{"tags":["DuplicateEntity"],"summary":"Copy an invoice to Invoice/Quote or vice versa","operationId":"DuplicateEntity_Post","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"duplicateEntity","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.DuplicateEntity"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/ecsl/{vatReturnId}/vaterrors":{"get":{"tags":["ECSL"],"summary":"Gets the ECSL error details to fix VAT number","operationId":"ECSL_GetECSLVatNumberErrors","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"vatReturnId","in":"path","description":"the VAT return ID","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"ECSL VAT return ID details retrieved successfully.","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.VAT.ECSLVatNumberError.ECSLVatNumberErrorDetails"}},"404":{"description":"ECSL VAT return ID details not found.","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"put":{"tags":["ECSL"],"summary":"Check or Update the ECSL error details to fix VAT number based on mode provided\r\n            mode should either Update or CheckAndUpdate","operationId":"ECSL_CheckOrUpdateECSalesErrors","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"vatReturnId","in":"path","description":"the VAT return ID","required":true,"type":"integer","format":"int32"},{"name":"request","in":"body","description":"the check/update request details","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.VAT.ECSLVatNumberError.ECSLVatNumberErrorUpdateRequest"}}],"responses":{"200":{"description":"ECSL VAT return ID details retrieved successfully.","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.VAT.ECSLVatNumberError.ECSLVatNumberErrorDetails"}}},"deprecated":false}},"/email":{"post":{"tags":["Email"],"summary":"Send an email","operationId":"Email_Post","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"emailMessage","in":"body","description":"EmailMessage Details","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Email.EmailMessage"}},{"name":"async","in":"query","description":"Flag to send mail synchronously or asynchronously","required":false,"type":"boolean"}],"responses":{"204":{"description":"Email Sent"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/reports/emaillog":{"get":{"tags":["EmailLog"],"summary":"This API allows a developer to get an email log report.\r\n             The Email Logs shows a log of all emails sent from loaded account including the status, date and timestamp, where it has been sent to and whether you used your own SMTP configuration.\r\n             This can help check if there have been any problems emailing invoices over to customers and can help pinpoint if you have an issue with your SMTP configuration.","operationId":"EmailLog_GetEmailLogs","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"page","in":"query","description":"The page number to be retrieved. The default value is 1.","required":false,"type":"integer","format":"int32"},{"name":"perpage","in":"query","description":"The number of records to be returned in a page.\r\n             The default value is 10.\r\n             Maximum allowed records per page are 100.","required":false,"type":"integer","format":"int32"},{"name":"sortby","in":"query","description":"The field using which you would like to sort. The options are:\r\n            Status\r\n            Subject\r\n            FromName\r\n            FromEmailId\r\n            Created\r\n            Sent\r\n            ToEmailId\r\n            RecipientType\r\n            CustomSMTP.\r\n            Default is Created","required":false,"type":"string"},{"name":"order","in":"query","description":"Whether you want to sort the records in ascending (Asc) or descending (Desc) order.\r\n             The default sort order is ascending (Asc)","required":false,"type":"string"},{"name":"fromDate","in":"query","description":"The date from which records to be retrieved","required":false,"type":"string","format":"date-time"},{"name":"toDate","in":"query","description":"The date till which records to be retrieved","required":false,"type":"string","format":"date-time"},{"name":"subject","in":"query","description":"Use this, if you want to filter records containing particular string in the subject","required":false,"type":"string"},{"name":"email","in":"query","description":"Use this, if you want to filter records having particular email ID or containing specific string in the recipient/sender email","required":false,"type":"string"},{"name":"skipPerPageValidation","in":"query","description":"Set this to true, if you want to skip the per page validation.","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Paging[KashFlow.Accounting.Model.Reports.EmailLog.EmailLog]"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/emailoptions":{"get":{"tags":["EmailOptions"],"summary":"Get the data for Email options","operationId":"EmailOptions_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Email.EmailOptions"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"put":{"tags":["EmailOptions"],"summary":"Update data for Email options\r\n            <param name=\"userId\">userId</param><param name=\"emailOptions\">email</param>","operationId":"EmailOptions_Put","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"emailOptions","in":"body","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Email.EmailOptions"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Email.EmailOptions"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/emailtemplates":{"get":{"tags":["EmailTemplate"],"summary":"Get a list of email templates","operationId":"EmailTemplate_GetList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"objectType","in":"query","description":"Can be an Invoice|Quote|Customer","required":false,"type":"string"},{"name":"objectNumber","in":"query","description":"The unique identifier for the above object","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/emailtemplates/{number}":{"get":{"tags":["EmailTemplate"],"summary":"Get a list of email templates, by ID","operationId":"EmailTemplate_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/emailtemplates/defaultStatementTemplate":{"get":{"tags":["EmailTemplate"],"summary":"Get default statement template","operationId":"EmailTemplate_GetDefaultStatementTemplate","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/emailtemplates/defaultTemplate":{"get":{"tags":["EmailTemplate"],"summary":"Get default email template based on the template type","operationId":"EmailTemplate_GetDefaultEmailTemplateForEntity","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"templateType","in":"query","description":"The type of the email template 0 = Mileage,  1 = Report,  2 = Transactions,  3 = ReminderLetter1,  4 = ReminderLetter2,  5 = ReminderLetter3,  6 = EntityDefault,  7 = SmtpTestEmail","required":true,"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7]},{"name":"subEntityType","in":"query","description":"Sub entity type","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/{objectType}/{number}/emailtextsubstitutions":{"get":{"tags":["EmailTextSubstitution"],"summary":"Get text substitutions for placeholders in emails","operationId":"EmailTextSubstitution_GetEmailTextSubstitutions","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"objectType","in":"path","description":"","required":true,"type":"string"},{"name":"number","in":"path","description":"","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/expenses":{"get":{"tags":["Expense"],"summary":"Get a list of expenses","operationId":"Expense_GetList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"page","in":"query","description":"Page number. (default is 1)","required":false,"type":"integer","format":"int32"},{"name":"perpage","in":"query","description":"PerPage is number of records per page. (default is 10)","required":false,"type":"integer","format":"int32"},{"name":"order","in":"query","description":"Sorting order (asc or desc) (default is asc)","required":false,"type":"string"},{"name":"sortby","in":"query","description":"Sort By column/field name. (default is Number) 0 = Number,  1 = SupplierReference,  2 = SupplierName,  3 = PurchaseDate,  4 = PaymentDueDate,  5 = GrossAmount,  6 = NetAmount,  7 = Status,  8 = PaidDate,  9 = DueAmount,  10 = Type,  11 = Project,  12 = VAT","required":false,"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12]},{"name":"filterby","in":"query","description":"Sort By column/field name. (default is All) 0 = All,  1 = Unpaid,  2 = PartPaid,  3 = Overdue,  4 = OverduePartPaid,  5 = Overpaid,  6 = Paid,  7 = NotFullyPaid,  8 = ThisMonth,  9 = LastMonth","required":false,"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,9]},{"name":"suppliercode","in":"query","description":"sort expense having code starting with the provided string","required":false,"type":"string"},{"name":"searchtext","in":"query","description":"Search expense by text","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Paging[KashFlow.Accounting.DTO.Expense.ExpenseListResponse]"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No Expenses found"}},"deprecated":false},"post":{"tags":["Expense"],"summary":"Create an expense","operationId":"Expense_Post","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"expenseRequest","in":"body","description":"Expense Object","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Expense.ExpenseRequest"}}],"responses":{"201":{"description":"Created Expense successfully","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Expense.ExpenseResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No Expense found"}},"deprecated":false}},"/expenses/{number}":{"get":{"tags":["Expense"],"summary":"Get expense details, by ID","operationId":"Expense_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"Expense Number","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Expense.ExpenseResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No expense found"}},"deprecated":false},"put":{"tags":["Expense"],"summary":"Update an expense, by ID","operationId":"Expense_Update","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"Expense Number","required":true,"type":"integer","format":"int32"},{"name":"expenseRequest","in":"body","description":"Expense Object","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Expense.ExpenseRequest"}}],"responses":{"200":{"description":"Updated Expense successfully","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Expense.ExpenseResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No expenses found"}},"deprecated":false},"delete":{"tags":["Expense"],"summary":"Delete an expense, by ID","operationId":"Expense_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"Expense Number","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"Deleted Expense succesfully"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No supExpenseplier found with that code"}},"deprecated":false}},"/expenses/articles":{"get":{"tags":["Expense"],"summary":"Get a list of expense articles","operationId":"Expense_GetArticle","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["Expense"],"summary":"Create an expense article","operationId":"Expense_PostArticle","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"articleName","in":"body","description":"Expense Article Name","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Created Expense Article successfully"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No Expense found"}},"deprecated":false}},"/FeatureSwitch/{switchName}":{"get":{"tags":["FeatureSwitch"],"summary":"Check whether a feature is enabled","operationId":"FeatureSwitch_GetFeatureSwitch","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"switchName","in":"path","description":"","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/FeatureValue/{valueName}":{"get":{"tags":["FeatureSwitch"],"summary":"Get the LatestTaxYear and PVAStartDate parameter values","operationId":"FeatureSwitch_GetFeatureValue","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"valueName","in":"path","description":"","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/{objectType}/{objectNumber}/files":{"get":{"tags":["File"],"summary":"Get list of the files added for an entity","operationId":"File_GetList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"objectType","in":"path","description":"","required":true,"type":"string"},{"name":"objectNumber","in":"path","description":"","required":true,"type":"string"},{"name":"thumbnailSize","in":"query","description":"","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false},"post":{"tags":["File"],"summary":"Add a file from Dropbox","operationId":"File_FileUpload","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"objectType","in":"path","description":"","required":true,"type":"string"},{"name":"objectNumber","in":"path","description":"","required":true,"type":"integer","format":"int32"},{"name":"isBulk","in":"query","description":"","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/{objectType}/{objectNumber}/file":{"get":{"tags":["File"],"summary":"Get the details of a file added to an entity","operationId":"File_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"objectType","in":"path","description":"","required":true,"type":"string"},{"name":"objectNumber","in":"path","description":"","required":true,"type":"string"},{"name":"fileName","in":"query","description":"","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false},"delete":{"tags":["File"],"summary":"Delete a file from an entity","operationId":"File_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"objectType","in":"path","description":"","required":true,"type":"string"},{"name":"objectNumber","in":"path","description":"","required":true,"type":"string"},{"name":"fileName","in":"query","description":"","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/files":{"post":{"tags":["File"],"summary":"Upload a file to Dropbox","operationId":"File_Upload","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"objectType","in":"query","description":"","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/dropbox/authentication/url":{"get":{"tags":["File"],"summary":"Generate the referral URL for Dropbox","operationId":"File_SwapTokenForAccessTokenAndSecret","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"code","in":"query","description":"","required":true,"type":"string"},{"name":"state","in":"query","description":"","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/dropbox/authentication":{"get":{"tags":["File"],"summary":"Generate the URL to log in to Dropbox","operationId":"File_GetCallBackUrl","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"referralURL","in":"query","description":"","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/dropbox/account/info":{"get":{"tags":["File"],"summary":"Get the account details for Dropbox","operationId":"File_GetDropBoxAccountInformation","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/dropbox/account/disconnect":{"post":{"tags":["File"],"summary":"Disconnect the Dropbox account","operationId":"File_Disconnect","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/fixedassetregister/report":{"get":{"tags":["FixedAssetRegister"],"summary":"Get Asset report for User","operationId":"FixedAssetRegister_GetReportForUser","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"startDate","in":"query","required":true,"type":"string","format":"date-time"},{"name":"endDate","in":"query","required":true,"type":"string","format":"date-time"},{"name":"categoryNumbers","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.FixedAssetReport"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No Category Found"}},"deprecated":false}},"/fixedassetregister/category":{"get":{"tags":["FixedAssetRegister"],"summary":"Get asset category by number","operationId":"FixedAssetRegister_GetAssetCategory","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"categoryNumber","in":"query","description":"Category number","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.FixedAssetRegister.FixedAssetCategory"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["FixedAssetRegister"],"summary":"Create asset category","operationId":"FixedAssetRegister_CreateAssetCategory","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"categoryRequest","in":"body","description":"Category Request","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.FixedAssetRegister.AssetCategoryRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.FixedAssetRegister.FixedAssetCategory"}}},"deprecated":false},"delete":{"tags":["FixedAssetRegister"],"summary":"Delete asset category","operationId":"FixedAssetRegister_DeleteAssetCategory","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"categoryNumber","in":"query","description":"Category number to be deleted","required":true,"type":"integer","format":"int32"},{"name":"reassignCategoryNumber","in":"query","description":"Category number to reassign to assets","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"Category deleted"},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/fixedassetregister/category/{categoryNumber}":{"put":{"tags":["FixedAssetRegister"],"summary":"Update asset category","operationId":"FixedAssetRegister_UpdateAssetCategory","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"categoryNumber","in":"path","description":"Category Number","required":true,"type":"integer","format":"int32"},{"name":"categoryRequest","in":"body","description":"Category Request","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.FixedAssetRegister.AssetCategoryRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.FixedAssetRegister.FixedAssetCategory"}}},"deprecated":false}},"/fixedassetregister/categories":{"get":{"tags":["FixedAssetRegister"],"summary":"Get asset categories","operationId":"FixedAssetRegister_GetAssetCategories","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.AssetCategory"}}}},"deprecated":false}},"/fixedassetregister/category-list":{"get":{"tags":["FixedAssetRegister"],"summary":"Get list of asset categories","operationId":"FixedAssetRegister_GetCategoryList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.FixedAssetRegister.CategoryListResponse"}}}},"deprecated":false}},"/fixedassetregister/asset":{"get":{"tags":["FixedAssetRegister"],"summary":"Get asset by number","operationId":"FixedAssetRegister_GetAsset","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"assetNumber","in":"query","description":"Asset number","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.FixedAssetRegister.AssetRegisterItemResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["FixedAssetRegister"],"summary":"Create asset","operationId":"FixedAssetRegister_CreateAsset","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"asset","in":"body","description":"Asset","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.FixedAssetRegister.Asset"}}],"responses":{"200":{"description":"OK","schema":{"format":"int32","type":"integer"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"delete":{"tags":["FixedAssetRegister"],"summary":"Delete asset","operationId":"FixedAssetRegister_DeleteAsset","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"assetNumber","in":"query","description":"Asset number to be deleted","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"Asset deleted"},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/fixedassetregister/asset/{assetNumber}":{"put":{"tags":["FixedAssetRegister"],"summary":"Update asset","operationId":"FixedAssetRegister_UpdateAsset","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"assetNumber","in":"path","description":"Asset Number","required":true,"type":"integer","format":"int32"},{"name":"asset","in":"body","description":"Asset","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.FixedAssetRegister.Asset"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.FixedAssetRegister.Asset"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/fixedassetregister/asset-list":{"get":{"tags":["FixedAssetRegister"],"summary":"Get list of assets","operationId":"FixedAssetRegister_GetAssetRegisterList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.FixedAssetRegister.AssetDetails"}}}},"deprecated":false}},"/fixedassetregister/pending-assets":{"get":{"tags":["FixedAssetRegister"],"summary":"Get list of pending assets","operationId":"FixedAssetRegister_GetPendingAssets","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.FixedAssetRegister.PendingAsset"}}}},"deprecated":false}},"/fixedassetregister/pending-asset/{lineId}":{"put":{"tags":["FixedAssetRegister"],"summary":"Remove pending asset","operationId":"FixedAssetRegister_RemovePendingAsset","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"lineId","in":"path","description":"Line id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"Pending asset removed"},"404":{"description":"No pending asset found with the line id"}},"deprecated":false}},"/fixedassetregister/journal-list-by-asset-number":{"get":{"tags":["FixedAssetRegister"],"summary":"Get list of journals by asset number","operationId":"FixedAssetRegister_GetJournalListByAssetNumber","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"assetNumber","in":"query","description":"Asset number","required":true,"type":"integer","format":"int32"},{"name":"JournalEntriesFilter","in":"query","description":"Filter for journal entries 0 = AllEntries,  1 = UnpostedEntries,  2 = ThisMonthEntries,  3 = LastMonthEntries,  4 = Templates,  5 = ThisYearEntries","required":true,"type":"integer","format":"int32","enum":[0,1,2,3,4,5]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Journal"}}}},"deprecated":false}},"/gocardless/connect":{"get":{"tags":["GoCardless"],"summary":"Generate the URL to create a GoCardless account","operationId":"GoCardless_GetConnectUrl","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"referralURL","in":"query","description":"","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/gocardless/login":{"get":{"tags":["GoCardless"],"summary":"Generate the URL to log in to GoCardless","operationId":"GoCardless_GetLoginUrl","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"referralURL","in":"query","description":"","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/gocardless/access_token":{"get":{"tags":["GoCardless"],"summary":"Get the GoCardless access token, once authenticated","operationId":"GoCardless_GetGoCardlessAcessToken","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"state","in":"query","description":"","required":true,"type":"string"},{"name":"code","in":"query","description":"","required":false,"type":"string"},{"name":"error","in":"query","description":"","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/gocardless/status":{"get":{"tags":["GoCardless"],"summary":"Get the verification status of the GoCardless credentials","operationId":"GoCardless_GetGoCardlessVerficationStatus","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"string"}}},"deprecated":false}},"/gocardless/disconnect":{"delete":{"tags":["GoCardless"],"summary":"Disconnect the GoCardless account","operationId":"GoCardless_Disconnect","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/gocardless/Webhook":{"post":{"tags":["GoCardless"],"summary":"Callback from GoCardless for processing mandates, payments, and payouts","operationId":"GoCardless_ProcessWebhook","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"goCardlessWebhookEventList","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.GoCardlessWebhookEvents"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/help/support-access":{"get":{"tags":["Help"],"summary":"Retrieves the current support access value.","operationId":"Help_GetSupportAccessValue","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"boolean"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false},"put":{"tags":["Help"],"summary":"Updates the support access value.","operationId":"Help_UpdateSupportAccessValue","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"enableSupportAccess","in":"query","description":"A boolean indicating whether to enable or disable support access.","required":true,"type":"boolean"}],"responses":{"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/help/zendesk":{"post":{"tags":["Help"],"summary":"Creates a Zendesk support ticket based on the provided request details.","operationId":"Help_CreateZendeskTicket","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"zendeskRequest","in":"body","description":"The request details for creating a Zendesk ticket.","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Zendesk.ZendeskRequest"}}],"responses":{"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/helpcontent/{helpcontentId}":{"get":{"tags":["HelpContent"],"summary":"Get help content for selected help ID","operationId":"HelpContent_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"helpcontentId","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/iap/receipts":{"put":{"tags":["InAppPurchases"],"summary":"Update existing iOS subscription once receipt is received","operationId":"InAppPurchases_PutReceiptAsync","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"receiptData","in":"body","description":"The encoded base64 string that represents the iOS receipt","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The provided subscription is active"},"400":{"description":"This receipt could not be authorized. Treat this the same as if a purchase was never made"},"409":{"description":"The IAP Apple receipt provided does not belong to your user"}},"deprecated":false},"post":{"tags":["InAppPurchases"],"summary":"Create a new iOS subscription once receipt is received","operationId":"InAppPurchases_PostReceiptAsync","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"receiptData","in":"body","description":"The encoded base64 string that represents the iOS receipt","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Receipt is valid"},"400":{"description":"This receipt could not be authorized. Treat this the same as if a purchase was never made"},"409":{"description":"The IAP Apple receipt provided does not belong to your user"}},"deprecated":false}},"/integrations":{"get":{"tags":["Integration"],"summary":"Get a list of available integrations","operationId":"Integration_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/integrations/gocardless":{"delete":{"tags":["Integration"],"summary":"Remove GoCardless from the Apps page","operationId":"Integration_DeleteGoCardless","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/integrations/settings/receiptbank":{"get":{"tags":["IntegrationsSettings"],"summary":"Get the Receipt Bank integration information","operationId":"IntegrationsSettings_GetRecieptBankSettings","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/invoices":{"get":{"tags":["Invoice"],"summary":"Get a list of invoices","operationId":"Invoice_GetPage","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"isSalesReport","in":"query","description":"Is sales report","required":false,"type":"boolean"},{"name":"page","in":"query","description":"Page number. (default is 1)","required":false,"type":"integer","format":"int32"},{"name":"perpage","in":"query","description":"PerPage is number of records per page. (default is 50)","required":false,"type":"integer","format":"int32"},{"name":"order","in":"query","description":"Sorting order (asc or desc) (default is asc)","required":false,"type":"string"},{"name":"sortby","in":"query","description":"Sort By column/field name. (default is Number) 0 = Number,  1 = CustomerRef,  2 = CustomerName,  3 = InvoiceDate,  4 = PaymentDueDate,  5 = GrossAmount,  6 = NetAmount,  7 = Status,  8 = PaymentPaidDate,  9 = DueAmount,  10 = Type,  11 = VATAmount,  12 = Project","required":false,"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12]},{"name":"customercode","in":"query","description":"Customer code","required":false,"type":"string"},{"name":"statusfilter","in":"query","description":"Status Filter","required":false,"type":"string"},{"name":"projectnumber","in":"query","description":"Project Number","required":false,"type":"integer","format":"int32"},{"name":"issuedatefrom","in":"query","description":"For issue date filter","required":false,"type":"string"},{"name":"issuedateto","in":"query","description":"For issue date filter","required":false,"type":"string"},{"name":"searchtext","in":"query","description":"Reference","required":false,"type":"string"},{"name":"source","in":"query","description":"Send \"MatchingEngine\" if request has been sent from matching engine otherwise empty(\"\").\r\n            In the case of Source as \"MatchingEngine\", API will consider \"Customer code\",\"Project Number\" and \"Issue date filter\" fields are default values","required":false,"type":"string"},{"name":"archived","in":"query","description":"For archived filter","required":false,"type":"string"},{"name":"dosearchwithdueamount","in":"query","description":"For search with due amount","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Paging[KashFlow.Accounting.DTO.Invoice.InvoiceListResponse]"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["Invoice"],"summary":"Create an invoice","operationId":"Invoice_Create","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"invoiceRequest","in":"body","description":"Invoice details","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Invoice.InvoiceRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"201":{"description":"Created","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Invoice.InvoiceResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/invoices/topdue":{"get":{"tags":["Invoice"],"summary":"Get a list of invoices, by due date","operationId":"Invoice_GetTopDue","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"customercode","in":"query","description":"The customercode.","required":false,"type":"string"},{"name":"searchText","in":"query","description":"The search text.","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.InvoiceSummary"}}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No customer found with that code"}},"deprecated":false}},"/invoices/{number}":{"get":{"tags":["Invoice"],"summary":"Get invoice details, by ID","operationId":"Invoice_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"invoice number","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Invoice.InvoiceResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No invoice found with that number"}},"deprecated":false},"put":{"tags":["Invoice"],"summary":"Update an invoice","operationId":"Invoice_Update","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"Invoice number which needs to be updated","required":true,"type":"integer","format":"int32"},{"name":"invoiceRequest","in":"body","description":"Invoice details to be updated","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Invoice.InvoiceRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Invoice.InvoiceResponse"}},"201":{"description":"Created","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Invoice.InvoiceResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No invoice found with that number"}},"deprecated":false},"delete":{"tags":["Invoice"],"summary":"Delete an invoice, by ID","operationId":"Invoice_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"Invoice number to be deleted","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"Invoice deleted"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No invoice found with that number"}},"deprecated":false}},"/internal/invoices":{"put":{"tags":["Invoice"],"summary":"Assign a project to multiple invoices","operationId":"Invoice_AssignProjectToInvoices","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"assignproject","in":"query","description":"project number to be assifned","required":true,"type":"integer","format":"int32"},{"name":"invoiceNumbers","in":"body","description":"List of invoices to update project","required":true,"schema":{"type":"array","items":{"format":"int32","type":"integer"}}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"Assigned project to invoices"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["Invoice"],"summary":"Convert multiple quotes to invoices","operationId":"Invoice_ConvertEntities","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"convertfrom","in":"query","description":"entity to be converted. Here it is always quote","required":true,"type":"string"},{"name":"entityNumbers","in":"body","description":"List of quote numbers to be converted","required":true,"schema":{"type":"array","items":{"format":"int32","type":"integer"}}},{"name":"retainafterconversion","in":"query","description":"Flag to retain or delete the original entity after deletion","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"201":{"description":"Created","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.QuoteAndConvertedInvoiceNumber"}}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/invoicelist":{"delete":{"tags":["Invoice"],"summary":"Delete multiple invoices","operationId":"Invoice_DeleteInvoices","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"invoiceNumbers","in":"body","description":"List of invoice numbers to be deleted","required":true,"schema":{"type":"array","items":{"format":"int32","type":"integer"}}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"204":{"description":"Deleted invoices"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/invoices/archive-status/{isArchived}":{"put":{"tags":["Invoice"],"summary":"Archive or unarchive multiple invoices, by invoice number","operationId":"Invoice_UpdateInvoiceArchiveStatus","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"isArchived","in":"path","description":"1 for archive and 0 for unarchive","required":true,"type":"boolean"},{"name":"invoiceNumbers","in":"body","description":"list of invoice numbers","required":true,"schema":{"type":"array","items":{"format":"int32","type":"integer"}}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"Archived invoices"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/invoicecountforsubscriptioncycle":{"get":{"tags":["Invoice"],"summary":"Get invoice count for current user","operationId":"Invoice_GetInvoicesCreatedForSubscriptionCycle","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"format":"int32","type":"integer"}}},"deprecated":false}},"/internal/invoices/{number}/emailcount":{"put":{"tags":["Invoice"],"summary":"Increment the email count for an invoice","operationId":"Invoice_IncrementEmailCount","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"Invoice number to update the email count","required":true,"type":"integer","format":"int32"},{"name":"updateMarkAsSentDate","in":"query","description":"Update mark as sent date","required":false,"type":"boolean"}],"responses":{"200":{"description":"Incremented email count for invoice"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/internal/invoices/{number}/emailcount/reset":{"put":{"tags":["Invoice"],"summary":"Reset the email count for an invoice","operationId":"Invoice_ResetEmailCount","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Reset email count for invoice"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/itsa/annualsummary":{"get":{"tags":["ItsaAnnualSummary"],"summary":"Get self-employment annual summary for a tax year.","operationId":"ItsaAnnualSummary_GetAnnualSummary","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"taxYear","in":"query","description":"The tax year to which the data applies for example: 2017-18","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.AnnualSummaryResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.AnnualSummaryResponse"}}},"deprecated":false},"put":{"tags":["ItsaAnnualSummary"],"summary":"Create/ Ammend self-employment annual summary for a tax year.","operationId":"ItsaAnnualSummary_UpdateAnnualSummary","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"annualSummary","in":"body","description":"Annual summary data to put, if want to delete then send blank","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.AnnualSummaryRequest"}},{"name":"taxYear","in":"query","description":"The tax year to which the data applies for example: 2017-18","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"Created/ Updated Annual summary"},"400":{"description":"Not Created/ Updated Annual summary"},"401":{"description":"Unauthorized Access ","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"delete":{"tags":["ItsaAnnualSummary"],"summary":"Delete self-employment annual summary for a tax year.","operationId":"ItsaAnnualSummary_DeleteAnnualSummary","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"taxYear","in":"query","description":"The tax year for which annual summary is to be deleted for example: 2017-18","required":true,"type":"string"}],"responses":{"200":{"description":"Deleted Annual summary"},"400":{"description":"Not Deleted Annual summary"},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/itsa/businesses":{"get":{"tags":["ItsaBusiness"],"summary":"Get the list of businesses for ITSA","operationId":"ItsaBusiness_GetBusinesses","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"typeOfBusiness","in":"query","description":"Type Of Business for list 0 = All,  1 = selfEmployment,  2 = ukProperty,  3 = foreignProperty,  4 = propertyUnspecified,  5 = ukPropertyNonFhl","required":false,"type":"integer","format":"int32","enum":[0,1,2,3,4,5]},{"name":"nino","in":"query","description":"Provide NINO, it's optional","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.PartBusinessResponse"}}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["ItsaBusiness"],"summary":"Create a new business (used for testing only)","operationId":"ItsaBusiness_CreateBusiness","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"business","in":"body","description":"Provide all properties, all are compulsary properties","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.BusinessRequest"}},{"name":"nino","in":"query","description":"Provide NINO, it's optional","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"201":{"description":"Created"},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/itsa/businesses/{id}":{"get":{"tags":["ItsaBusiness"],"summary":"Get the business details, by ID","operationId":"ItsaBusiness_GetBusiness","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"Business Id","required":true,"type":"string"},{"name":"nino","in":"query","description":"Nino","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.BusinessResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/itsa/businessincomesourcesummary":{"get":{"tags":["ITSABusinessIncomeSourceSummary"],"summary":"Retrieve a Self-Employment Business Income Source Summary (BISS)","operationId":"ITSABusinessIncomeSourceSummary_GetSelfEmploymentBISS","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"taxYear","in":"query","description":"Tax year","required":true,"type":"string"},{"name":"refreshFlag","in":"query","description":"","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.ITSABusinessIncomeSourceSummaryResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.VatMossReturn.ErrorResponse"}}},"deprecated":false}},"/itsa/business-source-adjustable-summary/self-employment/{calculationId}":{"get":{"tags":["ITSABusinessSourceAdjustableSummary"],"summary":"Retrive Self-Employment business Source Adjustable Summary(BSAS)","operationId":"ITSABusinessSourceAdjustableSummary_GetSelfEmploymentBusinessSourecAdjustableSummary","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"calculationId","in":"path","description":"The unique identifier of the business source adjustable summary.","required":true,"type":"string"},{"name":"adjustedStatus","in":"query","description":"To specify if the original (unadjusted) summary or adjusted summary.","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.SelfEmploymentBusinessSourceAdjustableSummaryResponse"}},"400":{"description":"BadRequest"},"401":{"description":"Unauthorized Access ","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.VatMossReturn.ErrorResponse"}}},"deprecated":false}},"/itsa/business-source-adjustable-summary/trigger":{"post":{"tags":["ITSABusinessSourceAdjustableSummary"],"summary":"Trigger Business Source Adjustable Summary(BSAS)","operationId":"ITSABusinessSourceAdjustableSummary_TriggerBusinessSourceAdjustbleSummary","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountingPeriodStartDate","in":"query","description":"Accounting Period Start Date (Format yyyy-mm-dd)","required":true,"type":"string"},{"name":"accountingPeriodEndDate","in":"query","description":"Accounting Period End Date (Format yyyy-mm-dd)","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"400":{"description":"BadRequest"},"401":{"description":"Unauthorized Access ","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.VatMossReturn.ErrorResponse"}}},"deprecated":false}},"/itsa/business-source-adjustable-summary/self-employment/adjustments/{calculationId}":{"get":{"tags":["ITSABusinessSourceAdjustableSummary"],"summary":"Retrive a Self-Employment Business Source Adjustable Summary(BSAS) Adjusment","operationId":"ITSABusinessSourceAdjustableSummary_GetSelfEmploymentBusinessSourecAdjustableSummaryAdjustments","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"calculationId","in":"path","description":"The unique identifier of the Business Source Adjustable Summary.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.SelfEmploymentBusinessSourceAdjustableSummaryAdjustmentResponse"}},"400":{"description":"BadRequest"},"401":{"description":"Unauthorized Access ","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.VatMossReturn.ErrorResponse"}}},"deprecated":false}},"/itsa/business-source-adjustable-summary/self-employment/adjustment/{calculationId}":{"post":{"tags":["ITSABusinessSourceAdjustableSummary"],"summary":"Submit Self Employment Business Source Adjustable Summary Adjustment","operationId":"ITSABusinessSourceAdjustableSummary_SubmitBSASSelfEmploymentAdjustment","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"calculationId","in":"path","description":"Business Source Adjustable Summary Id/ BSASId","required":true,"type":"string"},{"name":"bsasSelfEmploymentAdjustment","in":"body","description":"Self Employment Business Source Adjustable Summary Adjustment.","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.BSASSelfEmploymentAdjustment"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.BSASSelfEmploymentAdjustmentResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.VatMossReturn.ErrorResponse"}},"401":{"description":"Unauthorized Access ","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.VatMossReturn.ErrorResponse"}}},"deprecated":false}},"/itsa/business-source-adjustable-summary":{"get":{"tags":["ITSABusinessSourceAdjustableSummary"],"summary":"List Self employment Business Source Adjustable Summary(BSAS)","operationId":"ITSABusinessSourceAdjustableSummary_GetBusinessSourecAdjustableSummaryList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"taxYear","in":"query","description":"Provide taxYear as YYYY-YY e.g. 2019-20","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.BSASListResponse"}},"400":{"description":"BadRequest"},"401":{"description":"Unauthorized Access ","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.VatMossReturn.ErrorResponse"}}},"deprecated":false}},"/itsa/business-source-adjustable-summary/self-employment/{calculationId}/detail":{"get":{"tags":["ITSABusinessSourceAdjustableSummary"],"summary":"Retrive business Source Adjustable Summary(BSAS) in detail","operationId":"ITSABusinessSourceAdjustableSummary_GetSelfEmploymentBusinessSourceAdjustableSummaryDetail","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"calculationId","in":"path","description":"business Source Adjustable Summary Id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.SelfEmploymentBusinessSourceAdjustableSummaryDetail"}},"400":{"description":"BadRequest"},"401":{"description":"Unauthorized Access ","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.VatMossReturn.ErrorResponse"}}},"deprecated":false}},"/losses/loss-claims/create":{"post":{"tags":["ITSAIndividualLosses"],"summary":"Create a loss claim against an income source for a specific tax year.","operationId":"ITSAIndividualLosses_CreateLossClaim","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"typeOfClaim","in":"query","description":"Permitted values for \"self-employment\":carry-forward, carry-sideways.","required":true,"type":"string"},{"name":"taxYear","in":"query","description":"The tax year to which the claim applies","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"201":{"description":"Created"},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/losses/loss-claims/retrieve":{"get":{"tags":["ITSAIndividualLosses"],"summary":"Retrieve a loss claim against an income source for a specific tax year for the provided claimId.","operationId":"ITSAIndividualLosses_RetrieveLossClaim","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"claimId","in":"query","description":"Unique identifier for the loss claim. Ex - AAZZ0123456789a","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.IndividualLosses.LossClaimResponse"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/losses/loss-claims/list":{"get":{"tags":["ITSAIndividualLosses"],"summary":"List the existing loss claims information against an income source for a specific tax year.","operationId":"ITSAIndividualLosses_ListLossClaim","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"taxYear","in":"query","description":"The tax year to which the claim applies","required":true,"type":"string"},{"name":"typeOfClaim","in":"query","description":" 0 = all,  1 = carryForward,  2 = carrySideways","required":true,"type":"integer","format":"int32","enum":[0,1,2]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.IndividualLosses.ListLossClaimResponse"}}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/losses/loss-claims/amend-claim-type":{"post":{"tags":["ITSAIndividualLosses"],"summary":"Amend loss claim to change the type of claim for an existing loss claim type.","operationId":"ITSAIndividualLosses_AmendLossClaim","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"claimId","in":"query","description":"Claim Id","required":true,"type":"string"},{"name":"typeOfClaim","in":"query","description":"The type of claim to be applied. Permitted values for \"self-employment\": carry-forward, carry-sideways.","required":true,"type":"string"},{"name":"taxYear","in":"query","description":"The tax year to which the claim applies","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.IndividualLosses.LossClaimResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/losses/loss-claims/amend-claim-order":{"put":{"tags":["ITSAIndividualLosses"],"summary":"Amend loss claim order to change the sequence in which carry sideways losses are used.","operationId":"ITSAIndividualLosses_AmendLossClaimOrder","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"amendLossClaimOrderRequest","in":"body","description":"Amend loss claim order request data. Permitted values for self-employment TypeOfClaim: carry-sideways.","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.IndividualLosses.AmendLossClaimsOrderRequest"}},{"name":"taxYear","in":"query","description":"Tax year claimed for","required":true,"type":"string"}],"responses":{"200":{"description":"OK"},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/System.Object"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/losses/loss-claims/delete":{"delete":{"tags":["ITSAIndividualLosses"],"summary":"Delete an existing loss claim.","operationId":"ITSAIndividualLosses_DeleteLossClaim","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"claimId","in":"query","description":"ClaimId must be provided","required":true,"type":"string"},{"name":"taxYear","in":"query","description":"Tax Year must be provided","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"NoContent"},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/System.Object"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/losses/brought-forward/create":{"post":{"tags":["ITSAIndividualLosses"],"summary":"Create a new brought forward loss which can be submitted against typeOfLoss 'self-employment'.","operationId":"ITSAIndividualLosses_CreateBroughtForwardLoss","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"lossAmount","in":"query","description":"Brought Forward Loss amount related to the type of loss specified. The value must be between 0 and 99999999999.99 up to 2 decimal places.","required":true,"type":"number","format":"double"},{"name":"taxYear","in":"query","description":"The tax year to which the loss applies.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"201":{"description":"Created"},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/losses/brought-forward/retrieve":{"get":{"tags":["ITSAIndividualLosses"],"summary":"Retrieve an existing brought forward loss against provided lossId.","operationId":"ITSAIndividualLosses_RetrieveBroughtForwardLoss","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"lossId","in":"query","description":"The unique identifier of the loss.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.IndividualLosses.BroughtForwardLossClaimResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/losses/brought-forward/list":{"get":{"tags":["ITSAIndividualLosses"],"summary":"List of all brought forward losses against provided taxYear.","operationId":"ITSAIndividualLosses_ListBroughtForwardLosses","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"taxYear","in":"query","description":"The tax year to which the loss applies.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.IndividualLosses.ListBroughtForwardLossClaim"}}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/System.Object"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/losses/brought-forward/amend-loss-amount":{"post":{"tags":["ITSAIndividualLosses"],"summary":"Update an existing brought forward loss amount against the provided lossId.","operationId":"ITSAIndividualLosses_AmendBroughtForwardLossAmount","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"lossId","in":"query","description":"The 15 digit unique identifier of the loss.","required":true,"type":"string"},{"name":"lossAmount","in":"query","description":"Brought Forward Loss amount related to the type of loss specified. The value must be between 0 and 99999999999.99 up to 2 decimal places.","required":true,"type":"number","format":"double"},{"name":"taxYear","in":"query","description":"Tax Year must be provided","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.IndividualLosses.BroughtForwardLossClaimResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/System.Object"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/losses/brought-forward/delete":{"delete":{"tags":["ITSAIndividualLosses"],"summary":"Delete an existing brought forward loss.","operationId":"ITSAIndividualLosses_DeleteBroughtForwardLoss","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"lossId","in":"query","description":"The 15 digit unique identifier of the loss, must be provided.","required":true,"type":"string"},{"name":"taxYear","in":"query","description":"Tax Year must be provided","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"NoContent"},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/System.Object"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/itsa/late-accounting-date-rule-election/{taxYear}":{"get":{"tags":["ItsaLateAccountingDateRule"],"summary":"Retrieve Late Accounting Date Rule Election for a tax year (maps to HMRC GET .../late-accounting-date-rule-election).","operationId":"ItsaLateAccountingDateRule_GetLateAccountingDateRuleElection","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"taxYear","in":"path","description":"Tax year in the format yyyy-yy.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Periods.LateAccountingDateRuleResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/itsa/late-accounting-date-rule-election/{taxYear}/disapply":{"post":{"tags":["ItsaLateAccountingDateRule"],"summary":"Disapply Late Accounting Date Rule (maps to HMRC POST .../late-accounting-date-rule-election/disapply).","operationId":"ItsaLateAccountingDateRule_DisapplyLateAccountingDateRule","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"taxYear","in":"path","description":"Tax year in the format yyyy-yy.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"NoContent"},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/itsa/late-accounting-date-rule-election/{taxYear}/withdraw":{"delete":{"tags":["ItsaLateAccountingDateRule"],"summary":"Withdraw Late Accounting Date Rule election (maps to HMRC DELETE .../late-accounting-date-rule-election/withdraw).","operationId":"ItsaLateAccountingDateRule_WithdrawLateAccountingDateRule","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"taxYear","in":"path","description":"Tax year in the format yyyy-yy.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"NoContent"},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/itsa/logs/tax-calculation":{"get":{"tags":["ITSALogs"],"summary":"Get a list of Tax Calculations","operationId":"ITSALogs_GetPage","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"taxYear","in":"query","description":"Tax Year","required":true,"type":"string"},{"name":"page","in":"query","description":"Page number. (default is 1)","required":false,"type":"integer","format":"int32"},{"name":"perpage","in":"query","description":"PerPage is number of records per page. (default is 10)","required":false,"type":"integer","format":"int32"},{"name":"order","in":"query","description":"Sorting order (asc or desc) (default is desc)","required":false,"type":"string"},{"name":"fromdate","in":"query","description":"For from date filter eg. Format (yyyy-mm-dd)","required":false,"type":"string"},{"name":"todate","in":"query","description":"For to date filter eg. Format (yyyy-mm-dd)","required":false,"type":"string"},{"name":"sortby","in":"query","description":"Sort By column/field name. (default is TaxCalculationCreatedAt) 0 = TaxCalculationCreatedAt,  1 = Type,  2 = RequestedBy,  3 = User,  4 = TaxCalculationStatus","required":false,"type":"integer","format":"int32","enum":[0,1,2,3,4]},{"name":"type","in":"query","description":"Tax calculation Type 0 = InYear,  1 = FinalDeclaration,  2 = Crystallisation,  3 = All,  4 = IntentToAmend,  5 = IntentToFinalise","required":false,"type":"integer","format":"int32","enum":[0,1,2,3,4,5]},{"name":"status","in":"query","description":"Tax Calculation Status 0 = Blank,  1 = Success,  2 = Partial,  3 = Failed,  4 = InProgress,  -1 = All","required":false,"type":"integer","format":"int32","enum":[0,1,2,3,4,-1]},{"name":"taxcalculationcreatedat","in":"query","description":"ITSATaxCalculationCreatedAt  Format (yyyy-mm-dd)","required":false,"type":"string"},{"name":"requestedby","in":"query","description":"Tax Calculation RequestedBy 0 = Customer,  1 = Agent,  2 = HMRC,  -1 = All","required":false,"type":"integer","format":"int32","enum":[0,1,2,-1]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Paging[KashFlow.Accounting.Model.ITSA.ITSATaxCalculationForList]"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access ","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/itsa/logs/submission":{"get":{"tags":["ITSALogs"],"summary":"Get a list of Submission Logs.","operationId":"ITSALogs_GetPage","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountingPeriodStartDate","in":"query","description":"Accounting Period Start Date Format (yyyy-mm-dd)","required":true,"type":"string"},{"name":"accountingPeriodEndDate","in":"query","description":"Accounting Period End Date Format (yyyy-mm-dd)","required":true,"type":"string"},{"name":"page","in":"query","description":"Page number. (default is 1)","required":false,"type":"integer","format":"int32"},{"name":"perpage","in":"query","description":"PerPage is number of records per page. (default is 10)","required":false,"type":"integer","format":"int32"},{"name":"order","in":"query","description":"Sorting order (asc or desc) (default is desc)","required":false,"type":"string"},{"name":"sortby","in":"query","description":"Sort By column/field name. (default is SubmissionTimeStamp) 0 = SubmissionTimeStamp,  1 = SubmisionFromDate,  2 = SubmissionToDate,  3 = SubmissionType,  4 = RequestedBy,  5 = SubmissionLogStatus","required":false,"type":"integer","format":"int32","enum":[0,1,2,3,4,5]},{"name":"logdatetype","in":"query","description":"Date type (Default is SubmissionDate) 0 = All,  1 = SubmissionDate,  2 = SubmissionPeriodDate","required":false,"type":"integer","format":"int32","enum":[0,1,2]},{"name":"fromdate","in":"query","description":"Submission From Date","required":false,"type":"string"},{"name":"todate","in":"query","description":"Submission To Date","required":false,"type":"string"},{"name":"type","in":"query","description":"Type of submission 0 = All,  1 = PeriodicUpdate,  2 = AdjustmentAndAllowances,  3 = EOPS,  4 = Crystallization,  5 = BSAS","required":false,"type":"integer","format":"int32","enum":[0,1,2,3,4,5]},{"name":"requestedby","in":"query","description":"Submission Requested By 0 = All,  1 = Customer,  2 = Agent","required":false,"type":"integer","format":"int32","enum":[0,1,2]},{"name":"status","in":"query","description":"Status 0 = All,  2 = Failed,  3 = Successful","required":false,"type":"integer","format":"int32","enum":[0,2,3]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Paging[KashFlow.Accounting.Model.ITSA.ITSASubmissionLogForList]"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access ","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/itsa/logs/bsas":{"get":{"tags":["ITSALogs"],"summary":"Get a list of Business Source Adjustable Summary Logs","operationId":"ITSALogs_GetPage","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"nino","in":"query","required":true,"type":"string"},{"name":"businessId","in":"query","required":true,"type":"string"},{"name":"taxYear","in":"query","required":true,"type":"string"},{"name":"fromDate","in":"query","required":false,"type":"string"},{"name":"toDate","in":"query","required":false,"type":"string"},{"name":"page","in":"query","description":"Page number. (default is 1)","required":false,"type":"integer","format":"int32"},{"name":"perpage","in":"query","description":"PerPage is number of records per page. (default is 10)","required":false,"type":"integer","format":"int32"},{"name":"order","in":"query","description":"Sorting order (asc or desc) (default is desc)","required":false,"type":"string"},{"name":"sortby","in":"query","description":"Sort By column/field name. (default is RequestedTimeStamp) 0 = RequestedTimeStamp,  1 = RequestedBy,  2 = RequestedUser,  3 = Status,  4 = IsAdjusted","required":false,"type":"integer","format":"int32","enum":[0,1,2,3,4]},{"name":"summarystatus","in":"query","description":"BSAS summary status 0 = Blank,  1 = Valid,  2 = Invalid,  3 = Superseded,  -1 = All","required":false,"type":"integer","format":"int32","enum":[0,1,2,3,-1]},{"name":"requestedby","in":"query","description":"BSAS log Requested By 0 = All,  1 = Customer,  2 = Agent","required":false,"type":"integer","format":"int32","enum":[0,1,2]},{"name":"isadjusted","in":"query","description":"BSAS log Requested By 0 = False,  1 = True,  -1 = All","required":false,"type":"integer","format":"int32","enum":[0,1,-1]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Paging[KashFlow.Accounting.Model.ITSA.BSASLogsList]"}},"204":{"description":"NoContent"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access ","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/itsa/notification":{"get":{"tags":["ITSANotifications"],"summary":"Get Notification base on conditions","operationId":"ITSANotifications_GetNotification","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.ITSANotification"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access ","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/itsa/obligations/income-and-expenditure":{"get":{"tags":["ITSAObligation"],"summary":"Get the list of ITSA Income and Expenditure obligations","operationId":"ITSAObligation_GetIncomeAndExpenditureObligations","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"typeOfBusiness","in":"query","description":"Type of business 0 = selfEmployment,  1 = ukProperty,  2 = foreignProperty","required":false,"type":"integer","format":"int32","enum":[0,1,2]},{"name":"fromdate","in":"query","required":false,"type":"string"},{"name":"todate","in":"query","required":false,"type":"string"},{"name":"withperiods","in":"query","required":false,"type":"boolean"},{"name":"refreshflag","in":"query","required":false,"type":"boolean"},{"name":"isdeleteandrecreate","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.IncomeAndExpenditureObligationResponse"}},"400":{"description":"BadRequest"},"401":{"description":"Unauthorized Access ","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/itsa/obligations/crystallisation":{"get":{"tags":["ITSAObligation"],"summary":"Get Crystallisation obligations","operationId":"ITSAObligation_GetCrystallisationObligation","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"taxYear","in":"query","description":"The tax year to which the data applies for example: 2017-18","required":false,"type":"string"},{"name":"refreshFlag","in":"query","description":"To get data from HMRC","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.CrystallizationObligationsResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access ","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["ITSAObligation"],"summary":"Post Crystallisation obligations","operationId":"ITSAObligation_SubmitCrystallisationObligation","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"calculationId","in":"query","description":"The calculation ID that was returned by intent to crystallise endpoint.","required":true,"type":"string"},{"name":"taxYear","in":"query","description":"The tax year to which the data applies for example: 2017-18","required":true,"type":"string"},{"name":"finalDeclarationType","in":"query","description":"The type of final declaration. 0 = FinalDeclaration,  1 = ConfirmAmendment","required":true,"type":"integer","format":"int32","enum":[0,1]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.SubmitCrystallizationResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access ","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/itsa/obligations/allowance-and-adjustment":{"get":{"tags":["ITSAObligation"],"summary":"Get Allowances and Adjustment","operationId":"ITSAObligation_GetAllowanceAndAdjustmentObligation","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"fromDate","in":"query","description":"From date, yyyy-mm-dd","required":true,"type":"string"},{"name":"toDate","in":"query","description":"To date, yyyy-mm-dd","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.AllowanceAndAdjustmentObligation"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access ","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No obligation found for the date range"}},"deprecated":false}},"/itsa/periods":{"post":{"tags":["ITSAPeriod"],"summary":"Create the ITSA periods","operationId":"ITSAPeriod_CreatePeriods","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"createPeriodRequest","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Periods.CreatePeriodsRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"201":{"description":"Created","schema":{"type":"boolean"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"delete":{"tags":["ITSAPeriod"],"summary":"Delete any unsubmitted ITSA periods","operationId":"ITSAPeriod_DeletePeriods","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountingperiodid","in":"query","required":false,"type":"integer","format":"int32"},{"name":"startdate","in":"query","required":false,"type":"string"},{"name":"enddate","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"Deleted Sucessfully"},"400":{"description":"No periods to delete"}},"deprecated":false}},"/itsa/periods/by-hmrc":{"post":{"tags":["ITSAPeriod"],"summary":"Upsert ITSA periods submitted to HMRC","operationId":"ITSAPeriod_GetPeriods","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.UpsertPeriodResponse"}}},"400":{"description":"BadRequest"}},"deprecated":false}},"/itsa/periods/quarterly-period-type":{"put":{"tags":["ITSAPeriod"],"summary":"Create and Amend Quarterly Period Type for a Business","operationId":"ITSAPeriod_UpsertQuarterlyPeriodType","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"taxYear","in":"query","description":"Tax year","required":true,"type":"string"},{"name":"quarterlyPeriodType","in":"query","description":"Quarterly period type 0 = standard,  1 = calendar","required":false,"type":"integer","format":"int32","enum":[0,1]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"NoContent"},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/itsa/periods/accounting-type":{"get":{"tags":["ITSAPeriod"],"summary":"Get accounting type from HMRC for given tax year","operationId":"ITSAPeriod_GetAccountingType","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"taxYear","in":"query","description":"Tax year in the format yyyy-yy","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Periods.AccountingTypeResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"put":{"tags":["ITSAPeriod"],"summary":"Update accounting type to HMRC for given tax year","operationId":"ITSAPeriod_UpdateAccountingType","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"taxYear","in":"query","description":"Tax year in the format yyyy-yy","required":true,"type":"string"},{"name":"accountingType","in":"query","description":"Accounting type 0 = CASH,  1 = ACCRUAL","required":true,"type":"integer","format":"int32","enum":[0,1]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"NoContent"},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/itsa/periodicupdate":{"get":{"tags":["ITSAPeriodicUpdate"],"summary":"Get the ITSA Periodic Update","operationId":"ITSAPeriodicUpdate_GetPeriodicUpdates","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"periodkey","in":"query","required":false,"type":"string"},{"name":"startdate","in":"query","required":false,"type":"string"},{"name":"enddate","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.PeriodicUpdateResponse"}}},"deprecated":false},"put":{"tags":["ITSAPeriodicUpdate"],"summary":"Amend an ITSA Periodic Update","operationId":"ITSAPeriodicUpdate_UpdatePeriodicUpdate","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"periodicUpdate","in":"body","description":"from and to date format (yyyy-mm-dd), Income details, Expense details or Consolidated expense amount","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.PeriodicUpdate"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"NoContent","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.UpdatePeriodicUpdateResponse"}},"400":{"description":"Not Updated"},"401":{"description":"Unauthorized Access ","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["ITSAPeriodicUpdate"],"summary":"Create an ITSA Periodic Update","operationId":"ITSAPeriodicUpdate_CreatePeriodicUpdates","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"periodicUpdate","in":"body","description":"PeriodDates format (yyyy-mm-dd), PeriodIncome, PeriodAllowableExpenses and PeriodDisallowableExpenses","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.PeriodicUpdate"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"201":{"description":"Created Successfully"},"400":{"description":"Not Created"},"401":{"description":"Unauthorized Access ","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/itsa/periodicupdate/cumulative-periodic-update":{"get":{"tags":["ITSAPeriodicUpdate"],"summary":"Retrieve an self employment Cumulative Periodic Update","operationId":"ITSAPeriodicUpdate_RetrieveCumulativePeriodicUpdate","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"taxYear","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.PeriodicUpdateResponse"}},"401":{"description":"Unauthorized Access ","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"put":{"tags":["ITSAPeriodicUpdate"],"summary":"Create or amend an ITSA Cumulative Periodic Update","operationId":"ITSAPeriodicUpdate_UpsertCumulativePeriodicUpdate","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"periodicUpdate","in":"body","description":"from and to date format (yyyy-mm-dd), Income details, Expense details or Consolidated expense amount","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.PeriodicUpdate"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.UpdatePeriodicUpdateResponse"}},"400":{"description":"Not Updated"},"401":{"description":"Unauthorized Access ","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/itsa/periods-of-account":{"get":{"tags":["ItsaPeriodsOfAccount"],"summary":"Retrieve periods of account from HMRC for the tax year.","operationId":"ItsaPeriodsOfAccount_GetPeriodsOfAccount","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"taxYear","in":"query","description":"Tax year in the format yyyy-yy","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Periods.RetrievePeriodsOfAccountResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"put":{"tags":["ItsaPeriodsOfAccount"],"summary":"Create or update periods of account at HMRC for the tax year.","operationId":"ItsaPeriodsOfAccount_CreateOrUpdatePeriodsOfAccount","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"taxYear","in":"query","description":"Tax year in the format yyyy-yy","required":true,"type":"string"},{"name":"request","in":"body","description":"Periods of account payload","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Periods.CreateUpdatePeriodsOfAccountRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"NoContent"},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/itsa/settings":{"get":{"tags":["ITSASetting"],"summary":"Get the ITSA settings","operationId":"ITSASetting_GetITSASettings","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.SettingResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"put":{"tags":["ITSASetting"],"summary":"Configure the ITSA settings","operationId":"ITSASetting_UpsertITSASetting","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"itsaSetting","in":"body","description":"IncomeType: [1 (Sole trader), 2 (Property Business)]","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.SettingRequest"}},{"name":"refreshFlag","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.SettingResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/itsa/settings/GetAccountingYearList":{"get":{"tags":["ITSASetting"],"summary":"Get the ITSA Accounting Period list","operationId":"ITSASetting_GetAccountingPeriodList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.AccountingPeriodResponse"}}},"deprecated":false}},"/itsa/submission/auth_url":{"get":{"tags":["ITSASubmissionGateway"],"summary":"Get the authorization URL for the MTD ITSA API","operationId":"ITSASubmissionGateway_GetAuthorizationUrl","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"referralUrl","in":"query","description":"referral Url","required":true,"type":"string"}],"responses":{"200":{"description":"Returns hmrc authorization url"},"404":{"description":"Referral url cannot be empty","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/itsa/submission/accesstoken":{"get":{"tags":["ITSASubmissionGateway"],"summary":"Get the ITSA submission authorization result","operationId":"ITSASubmissionGateway_GetAcessToken","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"state","in":"query","description":"The value of the state parameter you provided in the authorisation request, whether or not authorisation is successful.","required":true,"type":"string"},{"name":"code","in":"query","description":"The authorisation code, if authorisation is successful","required":false,"type":"string"},{"name":"error","in":"query","description":"Always access_denied, if authorisation failed.","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/itsa/submission/disconnect":{"delete":{"tags":["ITSASubmissionGateway"],"summary":"Delete the MTD ITSA authorization token","operationId":"ITSASubmissionGateway_Disconnect","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"NoContent"}},"deprecated":false}},"/itsa/taxcalculation":{"get":{"tags":["ITSATaxCalculation"],"summary":"Get List of Tax Calculation","operationId":"ITSATaxCalculation_GetListOfTaxCalculation","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"taxYear","in":"query","description":"Provide taxYear as YYYY-YY e.g. 2018-19","required":false,"type":"string"}],"responses":{"201":{"description":"Created","schema":{"type":"string"}},"400":{"description":"Invalid Parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["ITSATaxCalculation"],"summary":"Create Tax calculation at HMRC","operationId":"ITSATaxCalculation_CreateTaxCalculation","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"taxYear","in":"query","description":"Provide taxYear as YYYY-YY e.g. 2018-19","required":true,"type":"string"},{"name":"calculationType","in":"query","description":"Tax calculation type 0 = InYear,  1 = FinalDeclaration,  2 = IntentToAmend","required":false,"type":"integer","format":"int32","enum":[0,1,2]}],"responses":{"201":{"description":"Created","schema":{"type":"string"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/itsa/taxcalculation/{calculationId}/income-tax-nics-calculated":{"get":{"tags":["ITSATaxCalculation"],"summary":"To Get Income tax and NICs Data","operationId":"ITSATaxCalculation_GetcalculatedITandNICAPI","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"calculationId","in":"path","description":"","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.ITSATaxCalculationResponse"}},"400":{"description":"BadRequest"}},"deprecated":false}},"/itsa/taxcalculation/{calculationId}/income-tax-allowances-deductions-reliefs":{"get":{"tags":["ITSATaxCalculation"],"summary":"To Get Income tax allowances deductions reliefs","operationId":"ITSATaxCalculation_GetTaxAllowancesDeductionsandReliefs","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"calculationId","in":"path","description":"","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.ITSATaxCalculationResponse"}},"400":{"description":"BadRequest"}},"deprecated":false}},"/itsa/taxcalculation/{calculationId}/taxable-income":{"get":{"tags":["ITSATaxCalculation"],"summary":"To Get Taxable Income","operationId":"ITSATaxCalculation_GetTaxableIncome","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"calculationId","in":"path","description":"Calculation Id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.ITSATaxCalculationResponse"}},"400":{"description":"BadRequest"}},"deprecated":false}},"/itsa/taxcalculation/{calculationId}/end-of-year-estimate":{"get":{"tags":["ITSATaxCalculation"],"summary":"To Get End of year estimate","operationId":"ITSATaxCalculation_GetEndOfYearEstimate","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"calculationId","in":"path","description":"Calculation Id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.ITSATaxCalculationResponse"}},"400":{"description":"BadRequest"}},"deprecated":false}},"/itsa/taxcalculation/{calculationId}/metadata":{"get":{"tags":["ITSATaxCalculation"],"summary":"To Get Tax Calculated Metadata","operationId":"ITSATaxCalculation_GetTaxableCalculatedMetadata","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"calculationId","in":"path","description":"Calculation Id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.ITSATaxCalculationResponse"}},"400":{"description":"BadRequest"}},"deprecated":false}},"/itsa/taxcalculation/{calculationId}/tax-calculation-messages":{"get":{"tags":["ITSATaxCalculation"],"summary":"To Get tax calculation messages","operationId":"ITSATaxCalculation_GetTaxCalculationMessages","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"calculationId","in":"path","description":"Calculation Id","required":true,"type":"string"},{"name":"calculationType","in":"query","description":"Calculation Type 0 = All,  1 = Info,  2 = Warning,  3 = Error,  4 = InfoAndWarning,  5 = WarningAndError,  6 = InfoAndError","required":false,"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.ITSATaxCalculationResponse"}},"400":{"description":"BadRequest"}},"deprecated":false}},"/itsa/taxcalculation/{calculationId}/consolidate-tax-calculation":{"get":{"tags":["ITSATaxCalculation"],"summary":"Get Consolidated Tax Calculation","operationId":"ITSATaxCalculation_GetConsolidatedTaxCalculation","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"calculationId","in":"path","description":"Tax Calculation","required":true,"type":"string"},{"name":"taxYear","in":"query","description":"Provide taxYear as YYYY-YY e.g. 2018-19","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.ITSAConsolidatedTaxCalculation"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/itsa/taxcalculation/tax-calculation-id":{"get":{"tags":["ITSATaxCalculation"],"summary":"Get Tax calculation id","operationId":"ITSATaxCalculation_GetLatestTaxCalculationId","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"taxYear","in":"query","description":"Provide taxYear as YYYY-YY e.g. 2018-19","required":true,"type":"string"},{"name":"taxCalculationType","in":"query","description":"Provide tax calculation type i.e. inYear or crystallisation 0 = InYear,  1 = FinalDeclaration,  2 = Crystallisation,  3 = All,  4 = IntentToAmend,  5 = IntentToFinalise","required":false,"type":"integer","format":"int32","enum":[0,1,2,3,4,5]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.CalculationIdResponse"}},"400":{"description":"BadRequest"}},"deprecated":false}},"/itsa/taxcalculation/liability/{taxYear}":{"get":{"tags":["ITSATaxCalculation"],"summary":"Get Income Tax Or Liability","operationId":"ITSATaxCalculation_GetIncomeTaxOrLiabilty","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"taxYear","in":"path","description":"Provide Taxyear as YYYY-YY e.g. 2018-19","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.IncomeTaxOrLiablityResponse"}},"400":{"description":"BadRequest"}},"deprecated":false}},"/itsa/taxcalculation/{calculationId}/tax-calculation":{"get":{"tags":["ITSATaxCalculation"],"summary":"Retrieve tax calculation","operationId":"ITSATaxCalculation_RetrieveTaxCalculation","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"calculationId","in":"path","description":"Provide Calculation Id","required":true,"type":"string"},{"name":"taxYear","in":"query","description":"Provide Taxyear as YYYY-YY e.g. 2018-19","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.ITSARetrieveTaxCalculationResponse"}},"400":{"description":"BadRequest"}},"deprecated":false}},"/itsa/taxcalculation/{calculationId}/report":{"get":{"tags":["ITSATaxCalculation"],"summary":"Get Tax calculation for Report","operationId":"ITSATaxCalculation_GetTaxCalculationForReport","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"calculationId","in":"path","description":"","required":true,"type":"string"},{"name":"taxYear","in":"query","description":"","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.TaxCalculationReportResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/jobs/alert/hmrconlinefiling":{"get":{"tags":["JobAlerts"],"summary":"Get the HMRC online filing job status","operationId":"JobAlerts_GetHmrcOnlineFilingStatus","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/journals":{"get":{"tags":["Journals"],"summary":"Get the journal list","operationId":"Journals_GetJournals","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"page","in":"query","description":"The page number to be retrieved. The default value is 1.","required":false,"type":"integer","format":"int32"},{"name":"perpage","in":"query","description":"The number of records to be returned in a page. The default value is 50. Maximum allowed records per page are 100.","required":false,"type":"integer","format":"int32"},{"name":"order","in":"query","description":"Whether you want to sort the records in ascending (Asc) or descending (Desc) order. The default sort order is ascending (Asc)","required":false,"type":"string"},{"name":"sortcolumn","in":"query","description":"The field using which you would like to sort. Available options are:\r\n            0 = Name\r\n            1 = Date\r\n            2 = Amount\r\n            3 = Category\r\n            default is 0 i.e., name 0 = Name,  1 = Date,  2 = Amount,  3 = Category,  4 = Comment,  5 = TemplateName","required":false,"type":"integer","format":"int32","enum":[0,1,2,3,4,5]},{"name":"searchtext","in":"query","description":"Provide this when you want to retrieve journals whose name starts with given string.","required":false,"type":"string"},{"name":"journalentriesfilter","in":"query","description":"Provide this when you want to retrieve journals having specific type of entries. Available options are:\r\n            0 = All entries\r\n            1 = Unposted entries\r\n            2 = This month entries\r\n            3 = Last month entries\r\n            4 = Templates\r\n            5 = This year entries\r\n            Default is 0 i.e., all entries 0 = AllEntries,  1 = UnpostedEntries,  2 = ThisMonthEntries,  3 = LastMonthEntries,  4 = Templates,  5 = ThisYearEntries","required":false,"type":"integer","format":"int32","enum":[0,1,2,3,4,5]},{"name":"category","in":"query","description":"Provide this when you want to retrieve journals with specific category. Available options are:\r\n            0 = Standard Journals\r\n            1 = Year End Journals\r\n            2 = Pre Payment and Accruals\r\n            3 = Deprecation\r\n            4 = Wages\r\n            5 = VAT\r\n            6 = VATMoss\r\n            7 = FRS Adjustment Journal\r\n             -1 = All Categories\r\n            Default is 0 i.e., Standard Journals 0 = StandardJournals,  1 = YearEndJournals,  2 = PrePaymentAndAccruals,  3 = Deprecation,  4 = Wages,  5 = VAT,  6 = VATMoss,  7 = FRSAdjustmentJournal,  -1 = AllCategories","required":false,"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,-1]},{"name":"project","in":"query","description":"Provide project number if you want to filter journals by specific project","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Paging[KashFlow.Accounting.DTO.Journal.JournalListResponse]"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["Journals"],"summary":"This API allows a developer to create a new journal.","operationId":"Journals_Create","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"journalRequest","in":"body","description":"Journal details","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Journal.JournalRequest"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Journal.JournalResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/journals/{number}":{"get":{"tags":["Journals"],"summary":"This API allows a developer to retrieve details of a specific journal by number.","operationId":"Journals_GetJournal","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"Journal number. Unique number used to represent a journal in your system for which you want to retrieve details","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Journal.JournalResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No Journal found with that number"}},"deprecated":false},"delete":{"tags":["Journals"],"summary":"This API allows a developer to delete an existing journal with the given number.","operationId":"Journals_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"Unique number used to represent a journal in system which you want to delete. Journal with given number must exists in system.","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"Journal deleted"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No Journal found with that number"}},"deprecated":false}},"/journals/{journalNumber}":{"put":{"tags":["Journals"],"summary":"This API allows a developer to modify an existing journal with the given number.","operationId":"Journals_Update","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"journalNumber","in":"path","description":"System generated unique Id for the journal. Not to be set while insert/update","required":true,"type":"integer","format":"int32"},{"name":"journalRequest","in":"body","description":"Journal details","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Journal.JournalRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Journal.JournalResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No Journal found with that number"}},"deprecated":false}},"/journallist":{"delete":{"tags":["Journals"],"summary":"Delete multiple journals, by Journal Numbers","operationId":"Journals_DeleteJournals","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"journalNumbers","in":"body","description":"Journal Numbers","required":true,"schema":{"type":"array","items":{"format":"int32","type":"integer"}}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"Journal deleted"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No Journal found with that number"}},"deprecated":false}},"/journals/template/{number}":{"get":{"tags":["Journals"],"summary":"This API allows a developer to retrieve details of a specific journal by number.","operationId":"Journals_GetJournalTemplate","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"Journal number. Unique number used to represent a journal in your system for which you want to retrieve details","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.JournalTemplate.JournalTemplateResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No Journal template found with that number"}},"deprecated":false},"put":{"tags":["Journals"],"summary":"This api allows user to update journal template","operationId":"Journals_UpdateTemplateJournal","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"Journal template number","required":true,"type":"integer","format":"int32"},{"name":"journalTemplateRequest","in":"body","description":"Journal template request data","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.JournalTemplate.JournalTemplateRequest"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.JournalTemplate.JournalTemplateResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/journals/template":{"get":{"tags":["Journals"],"summary":"Get the journal list","operationId":"Journals_GetJournalTemplates","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"page","in":"query","description":"Page number. (default is 1)","required":false,"type":"integer","format":"int32"},{"name":"perpage","in":"query","description":"PerPage is number of records per page. (default is 50)","required":false,"type":"integer","format":"int32"},{"name":"order","in":"query","description":"Sorting order (asc or desc) (default is asc)","required":false,"type":"string"},{"name":"sortcolumn","in":"query","description":"The field using which you would like to sort. (default is 0 i.e., Number)\r\n            Available options are: 0 = Number,  1 = Name","required":false,"type":"integer","format":"int32","enum":[0,1]},{"name":"searchtext","in":"query","description":"Provide this when you want to retrieve journal templates whose name contains with given string.","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Paging[KashFlow.Accounting.DTO.Journal.JournalListResponse]"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["Journals"],"summary":"This API allows a developer to create a new journal template.","operationId":"Journals_CreateTemplateJournal","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"journalTemplateRequest","in":"body","description":"Journal details","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.JournalTemplate.JournalTemplateRequest"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.JournalTemplate.JournalTemplateResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/journaltemplatelist":{"delete":{"tags":["Journals"],"summary":"Delete multiple journal templates, by Journal template numbers","operationId":"Journals_DeleteJournalTemplates","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"journalTemplateNumbers","in":"body","description":"Journal template numbers","required":true,"schema":{"type":"array","items":{"format":"int32","type":"integer"}}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No Journal found with that number"}},"deprecated":false}},"/jserror":{"post":{"tags":["JsError"],"summary":"Receive browser-related JavaScript errors","operationId":"JsError_Post","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"jsError","in":"body","description":"Details of error","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.JsError"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/reports/loginlog":{"get":{"tags":["LoginLog"],"summary":"This API allows a developer to get login log report. The Login Logs API gives a list of all the users who have logged into the account over a given period.\r\n            This shows the date and timestamp, username, the type of user account they have, and the IP address used. This is particularly useful if you find any irregularities on your account and want to see how it may have happened or who has been into the account.","operationId":"LoginLog_GetLoginLogs","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"page","in":"query","description":"The page number to be retrieved. The default value is 1.","required":false,"type":"integer","format":"int32"},{"name":"perpage","in":"query","description":"The number of records to be returned in a page.\r\n            The default value is 10. Maximum allowed records per page is 100.","required":false,"type":"integer","format":"int32"},{"name":"sortby","in":"query","description":"The field using which you would like to sort.\r\n            Available options are Date, UserName and UserType. Default is Date","required":false,"type":"string"},{"name":"order","in":"query","description":"Whether you want to sort the records in ascending (Asc) or descending (Desc) order.\r\n            The default sort order is ascending (Asc)","required":false,"type":"string"},{"name":"fromDate","in":"query","description":"The date from which records to be retrieved","required":false,"type":"string","format":"date-time"},{"name":"toDate","in":"query","description":"The date till which records to be retrieved","required":false,"type":"string","format":"date-time"},{"name":"userName","in":"query","description":"Use this, if you want to filter records containing particular string in the username of the user who had logged in","required":false,"type":"string"},{"name":"userType","in":"query","description":"Use this, if you want to filter records with User Type of the user who had logged in – MasterAdmin, Subuser, support etc.","required":false,"type":"string"},{"name":"skipPerPageValidation","in":"query","description":"Set this to true, if you want to skip the validation for maximum allowed records per page limit","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Paging[KashFlow.Accounting.Model.Reports.LoginLog.LoginLog]"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/mailtimeline":{"get":{"tags":["MailTimeLine"],"summary":"Get email status","operationId":"MailTimeLine_GetMailTimeLine","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"entityId","in":"query","description":"","required":true,"type":"integer","format":"int32"},{"name":"entityType","in":"query","description":"","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Core.Model.SendGrid.MailTimeLine"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Mail timeline does not exist for specified entity"}},"deprecated":false}},"/reports/managementreport":{"get":{"tags":["ManagementReport"],"summary":"Get the management report","operationId":"ManagementReport_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"query","description":"Id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.ManagementReport.ManagementReportSuite"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["ManagementReport"],"summary":"Create a management report","operationId":"ManagementReport_Create","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"cachedReportDetailsWrapper","in":"body","description":"Cached Report Detail","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.ManagementReport.CachedReportDetailsWrapper"}}],"responses":{"200":{"description":"OK","schema":{"format":"int32","type":"integer"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/customers/{customerCode}/mandates":{"get":{"tags":["Mandate"],"summary":"Get the customer mandate information","operationId":"Mandate_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"customerCode","in":"path","description":"Customer code to get mandate","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Response.MandateResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["Mandate"],"summary":"Create a new customer mandate","operationId":"Mandate_Create","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"customerCode","in":"path","description":"Customer code to create mandate for","required":true,"type":"string"},{"name":"mandateRequest","in":"body","description":"Mandate request object","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Request.MandateRequest"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Response.MandateResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"delete":{"tags":["Mandate"],"summary":"Delete a customer mandate","operationId":"Mandate_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"customerCode","in":"path","description":"Customer code for which mandate need to be deleted","required":true,"type":"string"}],"responses":{"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Deleted the mandate"}},"deprecated":false}},"/customers/{customerCode}/mandates/initiate/customertoken/{customerSessionToken}":{"get":{"tags":["Mandate"],"summary":"Generate the URL to confirm the customer mandate","operationId":"Mandate_SetupMandate","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"customerCode","in":"path","description":"KF customer code","required":true,"type":"string"},{"name":"customerSessionToken","in":"path","description":"Guid generated by KF system","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"301":{"description":"MovedPermanently","schema":{"type":"string"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/oneOff/initiate/customertoken/{customerSessionToken}/invoices/{invoiceId}":{"get":{"tags":["Mandate"],"summary":"Generate the URL to confirm the customer mandate for a one-off payment or a PayOnline payment","operationId":"Mandate_SetupOneOffMandate","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"customerSessionToken","in":"path","description":"Guid generated by KF system","required":true,"type":"string"},{"name":"invoiceId","in":"path","description":"KF invoice Id","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"301":{"description":"MovedPermanently","schema":{"type":"string"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/customers/{customerCode}/mandates/confirm/customertoken/{customerSessionToken}":{"get":{"tags":["Mandate"],"summary":"Create a mandate once  GoCardless authorization is received","operationId":"Mandate_ConfirmMandate","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"customerCode","in":"path","description":"KF customer code","required":true,"type":"string"},{"name":"customerSessionToken","in":"path","description":"Guid generated by KF system","required":true,"type":"string"},{"name":"redirect_flow_id","in":"query","description":"Id Provided by GoCardless","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"301":{"description":"MovedPermanently","schema":{"type":"string"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/oneoff/confirm/customertoken/{customerSessionToken}/invoices/{invoiceId}":{"get":{"tags":["Mandate"],"summary":"Create a one-off payment once  GoCardless authorization is received","operationId":"Mandate_ConfirmOneOffMandate","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"customerSessionToken","in":"path","description":"Guid generated by KF system","required":true,"type":"string"},{"name":"invoiceId","in":"path","description":"KF Invoice Id","required":true,"type":"integer","format":"int32"},{"name":"redirect_flow_id","in":"query","description":"Id Provided by GoCardless","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"301":{"description":"MovedPermanently","schema":{"type":"string"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/customers/{customerCode}/mandates/existingMandate":{"post":{"tags":["Mandate"],"summary":"Add an existing customer mandate","operationId":"Mandate_AddExistingMandate","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"customerCode","in":"path","description":"Customer code to which mandate needs to be set","required":true,"type":"string"},{"name":"mandateId","in":"query","description":"mandate Id","required":true,"type":"string"},{"name":"mandateRequest","in":"body","description":"Mandate request","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Request.MandateRequest"}}],"responses":{"200":{"description":"Direct Debit Mandate Id is now active","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"Expired","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ErrorCodes"}},"404":{"description":"Direct Debit Mandate Id does not exist or not active"}},"deprecated":false}},"/matchingengine/import/{bankAccountId}":{"post":{"tags":["MatchingEngine"],"summary":"import transactions into specific entities","operationId":"MatchingEngine_ImportTransaction","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"bankAccountId","in":"path","description":"bankAccountId","required":true,"type":"integer","format":"int32"},{"name":"importRequests","in":"body","description":"list of transaction","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Bank.ImportTransactionRequest"}}}],"responses":{"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/matchingengine/import/draft":{"post":{"tags":["MatchingEngine"],"summary":"Upsert Bank Transaction Draft","operationId":"MatchingEngine_SaveDraft","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"draftRequest","in":"body","description":"Draft request","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.MatchingEngine.BankTransactionDraftRequest"}}],"responses":{"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/matchingengine/import/draft/{bankAccountId}":{"get":{"tags":["MatchingEngine"],"summary":"Get Bank Transaction Draft","operationId":"MatchingEngine_GetDraft","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"bankAccountId","in":"path","description":"Account id","required":true,"type":"integer","format":"int32"}],"responses":{"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"delete":{"tags":["MatchingEngine"],"summary":"Delete Bank Transaction Draft","operationId":"MatchingEngine_DeleteDraft","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"bankAccountId","in":"path","description":"Bank account identity number","required":true,"type":"integer","format":"int32"}],"responses":{"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/metadata":{"get":{"tags":["Metadata"],"summary":"Get the account metadata(total invoice count, total customer count, for example)","operationId":"Metadata_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/mileage/enginesizes":{"get":{"tags":["Mileage"],"summary":"Get the engine size list","operationId":"Mileage_GetEnginesize","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Mileage.EngineSize"}}}},"deprecated":false}},"/mileage/enginetypes":{"get":{"tags":["Mileage"],"summary":"Get the engine type list","operationId":"Mileage_GetEnginetype","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Mileage.EngineType"}}}},"deprecated":false}},"/mileage/vehicletypes":{"get":{"tags":["Mileage"],"summary":"Get the vehicle type list","operationId":"Mileage_GetVehicletype","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Mileage.Vehicle"}}}},"deprecated":false}},"/mileage/employee":{"get":{"tags":["Mileage"],"summary":"Get all employees","operationId":"Mileage_GetEmployee","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"Employee list","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Mileage.MileageEmployee"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["Mileage"],"summary":"Create employee for mileage","operationId":"Mileage_CreateEmployee","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"employeeName","in":"query","description":"Employee name","required":true,"type":"string"}],"responses":{"200":{"description":"Employee created"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/mileage/employee/{employeeName}":{"put":{"tags":["Mileage"],"summary":"Update employee for mileage","operationId":"Mileage_UpdateEmployee","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"employeeName","in":"path","description":"Existing employee name","required":true,"type":"string"},{"name":"updatedName","in":"query","description":"Updated name","required":true,"type":"string"}],"responses":{"200":{"description":"Employee updated"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/mileage/{employeeId}":{"delete":{"tags":["Mileage"],"summary":"Delete employee by id","operationId":"Mileage_DeleteEmployee","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"employeeId","in":"path","description":"Employee id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"Employee has been deleted successfully."},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Employee does not exists."}},"deprecated":false}},"/mileage/employees":{"put":{"tags":["Mileage"],"summary":"Update bulk employees for mileage","operationId":"Mileage_UpdateEmployees","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"employees","in":"body","description":"List of employees to be updated","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Mileage.EmployeeUpdate"}}}],"responses":{"200":{"description":"Employees updated"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["Mileage"],"summary":"Create bulk employees for mileage","operationId":"Mileage_CreateEmployees","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"employees","in":"body","description":"List of employee names","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Employees created"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/nextavailableinvoicenumber":{"get":{"tags":["NextAvailableNumber"],"summary":"Get the next available invoice number","operationId":"NextAvailableNumber_GetInvoice","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/nextavailableprojectnumber":{"get":{"tags":["NextAvailableNumber"],"summary":"Get the next available project number","operationId":"NextAvailableNumber_GetProject","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/nextavailablepurchasenumber":{"get":{"tags":["NextAvailableNumber"],"summary":"Get the next available purchase number","operationId":"NextAvailableNumber_GetPurchase","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/nextavailablequotenumber":{"get":{"tags":["NextAvailableNumber"],"summary":"Get the next available quote number","operationId":"NextAvailableNumber_GetQuote","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/nextavailablepurchaseordernumber":{"get":{"tags":["NextAvailableNumber"],"summary":"Get the next available purchase order number","operationId":"NextAvailableNumber_GetPurchaseOrder","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/nominals":{"get":{"tags":["Nominal"],"summary":"Get the nominal list","operationId":"Nominal_GetNominals","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"type","in":"query","description":"type of nominal. Default is All","required":false,"type":"string"},{"name":"area","in":"query","description":"area of nominal. Default is All","required":false,"type":"string"},{"name":"searchText","in":"query","description":"search text","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Nominal.NominalList"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"put":{"tags":["Nominal"],"summary":"Update the SA103 category for multiple nominals","operationId":"Nominal_NominalsBulkUpdate","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"nominalRequest","in":"body","description":"Nominal request details to be updated","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Wrapper.NominalWarpper"}}],"responses":{"200":{"description":"Nominal updated"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["Nominal"],"summary":"Create a nominal","operationId":"Nominal_Create","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"nominalRequest","in":"body","description":"Nominal details","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Nominal.NominalRequest"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Nominal.NominalResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/nominals/{nominalType}/nominals":{"get":{"tags":["Nominal"],"summary":"Get the list of nominals for the reassign transactions along with the details of deleting nominal","operationId":"Nominal_GetDeleteNominalDetailsById","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"nominalType","in":"path","description":"the nominal type","required":true,"type":"integer","format":"int32"},{"name":"nominalId","in":"query","description":"the nominal Id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Tuple[System.Collections.Generic.IList[KashFlow.Accounting.Model.NominalBasic],KashFlow.Accounting.DTO.Nominal.NominalResponse]"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/nominals/{nominalCode}":{"get":{"tags":["Nominal"],"summary":"Get user nominals, by code","operationId":"Nominal_GetNominalByCode","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"nominalCode","in":"path","description":"nominal code","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Nominal.NominalResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"delete":{"tags":["Nominal"],"summary":"Delete a nominal by reassigning transactions to another nominal, By Code","operationId":"Nominal_DeleteNominalByCode","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"nominalCode","in":"path","description":"The Nominal Code to be deleted","required":true,"type":"integer","format":"int32"},{"name":"assignedCode","in":"query","description":"Nominal Code to which transaction need to be assigned","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"Nominal deleted"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No nominal found with that code"}},"deprecated":false}},"/nominals/Id/{nominalId}":{"get":{"tags":["Nominal"],"summary":"Get user nominals, by ID","operationId":"Nominal_GetNominalById","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"nominalId","in":"path","description":"nominal Id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Nominal.NominalResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"put":{"tags":["Nominal"],"summary":"Update a nominal, by ID","operationId":"Nominal_UpdateNominalById","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"nominalId","in":"path","description":"Nominal id which needs to be updated","required":true,"type":"integer","format":"int32"},{"name":"nominalRequest","in":"body","description":"Nominal details to be updated","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Nominal.NominalRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Nominal.NominalResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No nominal found with that id"}},"deprecated":false},"delete":{"tags":["Nominal"],"summary":"Delete a nominal by reassigning transactions to another nominal, By Id","operationId":"Nominal_DeleteNominalById","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"nominalId","in":"path","description":"The Nominal Id to be deleted","required":true,"type":"integer","format":"int32"},{"name":"assignedId","in":"query","description":"Nominal Id to which transaction need to be assigned","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"Nominal deleted"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No nominal found with that id"}},"deprecated":false}},"/internal/discountnominal":{"post":{"tags":["Nominal"],"summary":"Creates a discount nominal","operationId":"Nominal_Post","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"nominalDiscountRequest","in":"body","description":"Discount nominal details","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Nominal.NominalDiscountRequest"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Nominal.NominalResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/nominals/special":{"post":{"tags":["Nominal"],"summary":"Create a special nominal","operationId":"Nominal_CreateSpecialNominal","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"nominalSpecialRequest","in":"body","description":"NominalSpecialRequest","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Nominal.NominalSpecialRequest"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Nominal.NominalResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/nominals/sa103categories":{"get":{"tags":["Nominal"],"summary":"Get the SA103 category list","operationId":"Nominal_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Sa103Category"}}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/nominals/IsSa103Mapping":{"get":{"tags":["Nominal"],"summary":"To check all sa103 values are correctly mapped or not","operationId":"Nominal_IsSa103Mapping","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"sa103 correctly mapped or not. True/ False"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/nominals/{assignedCode}/nominallist":{"delete":{"tags":["Nominal"],"summary":"Bulk delete nominal by code","operationId":"Nominal_DeleteNominalsByCode","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"nominalCodes","in":"body","description":"The list of Nominal Codes to be deleted","required":true,"schema":{"type":"array","items":{"format":"int32","type":"integer"}}},{"name":"assignedCode","in":"path","description":"Nominal Code to which transaction need to be assigned","required":true,"type":"integer","format":"int32"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/nominals/{nominalcode}":{"put":{"tags":["Nominal"],"summary":"Update an nominal","operationId":"Nominal_UpdateNominalByCode","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"nominalcode","in":"path","description":"Nominal code which needs to be updated","required":true,"type":"integer","format":"int32"},{"name":"nominalRequest","in":"body","description":"Nominal details to be updated","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Nominal.NominalRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Nominal.NominalResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No nominal found with that code"}},"deprecated":false}},"/nominals/Code/{nominalCode}":{"put":{"tags":["Nominal"],"summary":"Update user default nominal type by code","operationId":"Nominal_UpdateUserDefaultNominalType","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"nominalCode","in":"path","description":"Nominal code","required":true,"type":"integer","format":"int32"},{"name":"nominalCategory","in":"query","description":"Nominal category 1 = SalesType,  2 = OutgoingType,  3 = BankTransactionType","required":true,"type":"integer","format":"int32","enum":[1,2,3]}],"responses":{"200":{"description":"OK","schema":{"format":"int32","type":"integer"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No nominal found with that id"}},"deprecated":false}},"/reports/nominalbreakdown":{"get":{"tags":["NominalBreakdownReport"],"summary":"Returns the nominal breakdown report for a given nominal code and date range.\r\n            Each row shows the date, entity type, reference, subtype, narrative, and debit/credit values\r\n            for transactions posted to the specified nominal code.","operationId":"NominalBreakdownReport_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"startdate","in":"query","required":true,"type":"string"},{"name":"enddate","in":"query","required":true,"type":"string"},{"name":"code","in":"query","required":false,"type":"integer","format":"int32"},{"name":"accountingtype","in":"query","description":" 0 = Cash,  1 = Accrual","required":false,"type":"integer","format":"int32","enum":[0,1]},{"name":"projectnumber","in":"query","required":false,"type":"integer","format":"int32"},{"name":"page","in":"query","required":false,"type":"integer","format":"int32"},{"name":"perpage","in":"query","required":false,"type":"integer","format":"int32"},{"name":"order","in":"query","required":false,"type":"string"},{"name":"sortby","in":"query","description":" 1 = Date,  2 = Reference,  3 = Narrative,  4 = DebitValue,  5 = CreditValue,  6 = ResourceNumber,  7 = EntityType,  8 = ProductCode","required":false,"type":"integer","format":"int32","enum":[1,2,3,4,5,6,7,8]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Paging[KashFlow.Accounting.Model.Reports.NominalBreakdownReport.NominalBreakdownReportItem,KashFlow.Accounting.Model.Reports.NominalBreakdownReport.NominalBreakdownReportPagingMetadata]"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/reports/nominalbreakdown/reassign":{"post":{"tags":["NominalBreakdownReport"],"summary":"Reassigns selected transactions from the nominal breakdown report to a new nominal code.\r\n            Each transaction is processed individually — successful reassignments and failures (bank lock,\r\n            VAT return incompatibility) are both included in the response.","operationId":"NominalBreakdownReport_Reassign","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"request","in":"body","description":"Reassignment request containing the target nominal code, an optional product code filter,\r\n            and the list of transactions to reassign.","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.NominalBreakdownReport.NominalBreakdownReassignRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.NominalBreakdownReport.NominalBreakdownReassignResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/reports/nominalledger/guid":{"post":{"tags":["NominalLedgerReport"],"operationId":"NominalLedgerReport_PostGuidCreate","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"nominalIds","in":"body","required":true,"schema":{"type":"array","items":{"format":"int32","type":"integer"}}},{"name":"startdate","in":"query","required":false,"type":"string","format":"date-time"},{"name":"enddate","in":"query","required":false,"type":"string","format":"date-time"},{"name":"nominalids","in":"query","required":false,"type":"array","items":{"type":"integer","format":"int32"}},{"name":"filterbyproject","in":"query","required":false,"type":"boolean"},{"name":"projectid","in":"query","required":false,"type":"integer","format":"int32"},{"name":"includeopeningbalance","in":"query","required":false,"type":"boolean"},{"name":"fordisallow","in":"query","required":false,"type":"boolean"},{"name":"accountingtype","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.NominalLedgerReport.NominalLedgerReport"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/{objectType}/{objectNumber}/notes":{"get":{"tags":["Note"],"summary":"Get a list of notes for an object, such as Customer or Supplier","operationId":"Note_GetList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"objectNumber","in":"path","description":"Is the Number of the above Object Type, used to identify the above object","required":true,"type":"string"},{"name":"objectType","in":"path","description":"Is the Type of Object i.e Invoice,Quote,Customer etc 1 = Customers,  2 = Suppliers,  3 = Invoices,  4 = Quotes,  5 = Purchases,  6 = PurchaseOrders","required":false,"type":"integer","format":"int32","enum":[1,2,3,4,5,6]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Base.NoteResponse"}}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["Note"],"summary":"Create a note for an object, such as Customer or Supplier","operationId":"Note_Create","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"objectNumber","in":"path","description":"Is the Number of the above Object Type, used to identify the above object","required":true,"type":"string"},{"name":"noteBase","in":"body","description":"Note details","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Base.NoteBase"}},{"name":"objectType","in":"path","description":"Is the Type of Object i.e Invoice,Quote,Customer etc 1 = Customers,  2 = Suppliers,  3 = Invoices,  4 = Quotes,  5 = Purchases,  6 = PurchaseOrders","required":false,"type":"integer","format":"int32","enum":[1,2,3,4,5,6]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"201":{"description":"Created","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Base.NoteResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/{objectType}/{objectNumber}/notes/{number}":{"get":{"tags":["Note"],"summary":"Get note details, by object and ID","operationId":"Note_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"objectNumber","in":"path","description":"Is the Number of the above Object Type, used to identify the above object","required":true,"type":"string"},{"name":"number","in":"path","description":"Is the Number of the Note to be fetched","required":true,"type":"integer","format":"int32"},{"name":"objectType","in":"path","description":"Is the type of Note object i.e Invoice,Quote,Customer etc 1 = Customers,  2 = Suppliers,  3 = Invoices,  4 = Quotes,  5 = Purchases,  6 = PurchaseOrders","required":false,"type":"integer","format":"int32","enum":[1,2,3,4,5,6]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Base.NoteResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No note found"}},"deprecated":false},"put":{"tags":["Note"],"summary":"Update a note for an object, such as Customer or Supplier","operationId":"Note_Update","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"objectNumber","in":"path","description":"Is the Number of the above Object Type, used to identify the above object","required":true,"type":"string"},{"name":"number","in":"path","description":"Is the Number of the Note to be Updated","required":true,"type":"integer","format":"int32"},{"name":"noteRequest","in":"body","description":"Note details to be updated","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Note.NoteRequest"}},{"name":"objectType","in":"path","description":"Is the Type of Object i.e Invoice,Quote,Customer etc 1 = Customers,  2 = Suppliers,  3 = Invoices,  4 = Quotes,  5 = Purchases,  6 = PurchaseOrders","required":false,"type":"integer","format":"int32","enum":[1,2,3,4,5,6]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Base.NoteResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No note found"}},"deprecated":false},"delete":{"tags":["Note"],"summary":"Delete a note for an object, such as Customer or Supplier","operationId":"Note_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"objectNumber","in":"path","description":"Is the Number of the above Object Type, used to identify the above object","required":true,"type":"string"},{"name":"number","in":"path","description":"Is the Number of the Note to be Deleted","required":true,"type":"integer","format":"int32"},{"name":"objectType","in":"path","description":"Is the Type of Object i.e Invoice,Quote,Customer etc","required":false,"type":"integer","format":"int32","enum":[1,2,3,4,5,6]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"Note deleted"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No note found"}},"deprecated":false}},"/okta/oauth-url":{"get":{"tags":["OAuth"],"summary":"Generate the URL to log in to elements account","operationId":"OAuth_GetLoginUrl","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/irisoauth/accesstoken":{"get":{"tags":["OAuth"],"summary":"Get the Elements access token, once authenticated","operationId":"OAuth_GetAcessToken","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"state","in":"query","description":"","required":true,"type":"string"},{"name":"code","in":"query","description":"","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/ocr/file/extraction-detail":{"get":{"tags":["OcrFile"],"summary":"Get OCR extraction detail","operationId":"OcrFile_GetOCRExtractionDetail","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.OCR.OcrPageUtilizationResponse"}},"204":{"description":"NoContent","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/partners/{partnerId}":{"get":{"tags":["Partner"],"summary":"Get partner details, by ID","operationId":"Partner_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"partnerId","in":"path","description":"Partner Id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Response.PartnerResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Partner id provided is invalid"}},"deprecated":false}},"/partners/{partnerId}/rsrcssdetails":{"get":{"tags":["Partner"],"summary":"Get the details of the partner's default company branding colours","operationId":"Partner_PartnerRsrCssDetails","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"partnerId","in":"path","description":"Partner Id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object","additionalProperties":{"type":"string"}}}},"deprecated":false}},"/password":{"put":{"tags":["Password"],"summary":"Change password and/or memorable word","operationId":"Password_Put","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"credential","in":"body","description":"Credential","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Credential"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false},"post":{"tags":["Password"],"summary":"Send a password reset link","operationId":"Password_Post","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"userCredentialResetDetail","in":"body","description":"userCredentialResetDetail","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.UserCredentialResetDetail"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/password/{resetToken}":{"get":{"tags":["Password"],"summary":"Get a password reset token","operationId":"Password_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"resetToken","in":"path","description":"resetToken","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false},"put":{"tags":["Password"],"summary":"Use a token to reset credentials","operationId":"Password_Put","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"resetToken","in":"path","description":"resetToken","required":true,"type":"string"},{"name":"userCredentialResetDetail","in":"body","description":"userCredentialResetDetail","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.UserCredentialResetDetail"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/password/breached":{"post":{"tags":["Password"],"summary":"Check if password breached beyond a limit","operationId":"Password_IsBreachedPassword","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"breachedPasswordRequest","in":"body","description":"breachedPasswordRequest","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Security.BreachedPasswordRequest"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}},"deprecated":false}},"/paymentmethods/{type}":{"get":{"tags":["PaymentMethod"],"summary":"Get the payment method details for an invoice or purchase","operationId":"PaymentMethod_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"type","in":"path","description":"type: invoice or purchase","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.PaymentMethod"}}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/paymentprocessors":{"get":{"tags":["PaymentProcessor"],"summary":"Get a list of payment processors","operationId":"PaymentProcessor_GetProcessorsList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.PaymentProcessor"}}}},"deprecated":false}},"/paymentprocessors/worldpay":{"get":{"tags":["PaymentProcessor"],"summary":"Get the WorldPay payment processor configuration details","operationId":"PaymentProcessor_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false},"put":{"tags":["PaymentProcessor"],"summary":"Update the WorldPay configuration details","operationId":"PaymentProcessor_Put","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"worldPayDetails","in":"body","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.WorldPayPaymentProcessor"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false},"post":{"tags":["PaymentProcessor"],"summary":"Create the WorldPay configuration details","operationId":"PaymentProcessor_Post","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/paymentprocessors/{processorType}/configuration":{"get":{"tags":["PaymentProcessor"],"summary":"Get the payment processor settings","operationId":"PaymentProcessor_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"processorType","in":"path","description":"The card payment processor type. 0 = NoCardPayments,  1 = SecureHosting,  2 = SagePay,  3 = IridiumCorp,  4 = Worldpay,  5 = ProcessingPoint,  6 = SagePaymentSolutions,  7 = SmartPay,  8 = AuthorizeDotNet,  9 = PayPalPro,  10 = PaymentSense,  11 = CardSave,  12 = CardStream,  14 = BarclayCardEPdq,  15 = GoCardless,  16 = McpePayPoint,  17 = GlobalPayments,  18 = EWayPayment,  19 = Stripe,  20 = BarclayCardEPdqExtraPlus,  21 = Square,  22 = IRISPay","required":true,"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,14,15,16,17,18,19,20,21,22]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Payment.CardPaymentConfigurations"}},"404":{"description":"No payment processor found, or the payment processor is deprecated"}},"deprecated":false},"put":{"tags":["PaymentProcessor"],"summary":"Update the card payment configuration details","operationId":"PaymentProcessor_UpdateAsync","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"processorType","in":"path","description":"The card payment processor type. 0 = NoCardPayments,  1 = SecureHosting,  2 = SagePay,  3 = IridiumCorp,  4 = Worldpay,  5 = ProcessingPoint,  6 = SagePaymentSolutions,  7 = SmartPay,  8 = AuthorizeDotNet,  9 = PayPalPro,  10 = PaymentSense,  11 = CardSave,  12 = CardStream,  14 = BarclayCardEPdq,  15 = GoCardless,  16 = McpePayPoint,  17 = GlobalPayments,  18 = EWayPayment,  19 = Stripe,  20 = BarclayCardEPdqExtraPlus,  21 = Square,  22 = IRISPay","required":true,"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,14,15,16,17,18,19,20,21,22]},{"name":"cardPaymentConfigurations","in":"body","description":"The card payment configurations.","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Payment.CardPaymentConfigurations"}}],"responses":{"200":{"description":"The card payment processor was updated","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Payment.CardPaymentConfigurations"}},"400":{"description":"The request is invalid","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No payment processor found with that key, or the payment processor is deprecated"}},"deprecated":false}},"/paymentprocessors/{processorType}/default":{"put":{"tags":["PaymentProcessor"],"summary":"Update the default payment processor used for card payments","operationId":"PaymentProcessor_SetDefault","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"processorType","in":"path","description":"Type of the processor. 0 = NoCardPayments,  1 = SecureHosting,  2 = SagePay,  3 = IridiumCorp,  4 = Worldpay,  5 = ProcessingPoint,  6 = SagePaymentSolutions,  7 = SmartPay,  8 = AuthorizeDotNet,  9 = PayPalPro,  10 = PaymentSense,  11 = CardSave,  12 = CardStream,  14 = BarclayCardEPdq,  15 = GoCardless,  16 = McpePayPoint,  17 = GlobalPayments,  18 = EWayPayment,  19 = Stripe,  20 = BarclayCardEPdqExtraPlus,  21 = Square,  22 = IRISPay","required":true,"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,14,15,16,17,18,19,20,21,22]}],"responses":{"204":{"description":"Set as the default payment processor"},"404":{"description":"No payment processor found, or the payment processor is deprecated"}},"deprecated":false},"delete":{"tags":["PaymentProcessor"],"summary":"Remove the default payment processor","operationId":"PaymentProcessor_UnsetDefault","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"processorType","in":"path","description":"Type of the processor.","required":true,"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,14,15,16,17,18,19,20,21,22]}],"responses":{"204":{"description":"Unset as the default payment processor"},"404":{"description":"No payment processor found, or the payment processor is deprecated"}},"deprecated":false}},"/paymentprocessors/AdvtPayment":{"put":{"tags":["PaymentProcessor"],"summary":"Update the default payment processor using the Acquirer Device Validation Toolkit","operationId":"PaymentProcessor_HidePaymentAdvtPopUp","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"isAdvtPayment","in":"query","required":true,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/paymentprocessors/activedeprecated":{"get":{"tags":["PaymentProcessor"],"summary":"Get the list of active deprecated payment processors","operationId":"PaymentProcessor_GetActiveDeprecatedProcessor","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.PaymentProcessor"}},"404":{"description":"No active deprecated payment processor found"}},"deprecated":false}},"/paymentprocessors/{processorType}/authorize":{"get":{"tags":["PaymentProcessor"],"summary":"Authorize the payment processor","operationId":"PaymentProcessor_AuthorizePaymentProcessor","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"processorType","in":"path","description":"The payment processor. 0 = NoCardPayments,  1 = SecureHosting,  2 = SagePay,  3 = IridiumCorp,  4 = Worldpay,  5 = ProcessingPoint,  6 = SagePaymentSolutions,  7 = SmartPay,  8 = AuthorizeDotNet,  9 = PayPalPro,  10 = PaymentSense,  11 = CardSave,  12 = CardStream,  14 = BarclayCardEPdq,  15 = GoCardless,  16 = McpePayPoint,  17 = GlobalPayments,  18 = EWayPayment,  19 = Stripe,  20 = BarclayCardEPdqExtraPlus,  21 = Square,  22 = IRISPay","required":true,"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,14,15,16,17,18,19,20,21,22]},{"name":"code","in":"query","required":false,"type":"string"},{"name":"redirect_uri","in":"query","required":false,"type":"string"},{"name":"state","in":"query","required":false,"type":"string"},{"name":"refresh_token","in":"query","required":false,"type":"string"},{"name":"error","in":"query","required":false,"type":"string"},{"name":"error_description","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"The redirect location","schema":{"type":"string"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/System.Object"}},"404":{"description":"No payment processor found, or the payment processor is deprecated"}},"deprecated":false}},"/paymentprocessors/{processorType}/disconnect":{"put":{"tags":["PaymentProcessor"],"summary":"Disconnect the payment processor","operationId":"PaymentProcessor_DisconnectPaymentAsync","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"processorType","in":"path","description":"Type of the processor. 0 = NoCardPayments,  1 = SecureHosting,  2 = SagePay,  3 = IridiumCorp,  4 = Worldpay,  5 = ProcessingPoint,  6 = SagePaymentSolutions,  7 = SmartPay,  8 = AuthorizeDotNet,  9 = PayPalPro,  10 = PaymentSense,  11 = CardSave,  12 = CardStream,  14 = BarclayCardEPdq,  15 = GoCardless,  16 = McpePayPoint,  17 = GlobalPayments,  18 = EWayPayment,  19 = Stripe,  20 = BarclayCardEPdqExtraPlus,  21 = Square,  22 = IRISPay","required":true,"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,14,15,16,17,18,19,20,21,22]},{"name":"isPayonlineConfig","in":"query","description":"If set to true [is payonline configuration].","required":false,"type":"boolean"}],"responses":{"204":{"description":"NoContent"},"404":{"description":"No payment processor found, or the payment processor is deprecated"}},"deprecated":false}},"/paymentprocessors/{processorType}/oauthauthorizeurl":{"get":{"tags":["PaymentProcessor"],"summary":"Get the OAuth authorize URL","operationId":"PaymentProcessor_GetOAuthAuthorizeUrl","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"processorType","in":"path","description":"Type of the processor. 0 = NoCardPayments,  1 = SecureHosting,  2 = SagePay,  3 = IridiumCorp,  4 = Worldpay,  5 = ProcessingPoint,  6 = SagePaymentSolutions,  7 = SmartPay,  8 = AuthorizeDotNet,  9 = PayPalPro,  10 = PaymentSense,  11 = CardSave,  12 = CardStream,  14 = BarclayCardEPdq,  15 = GoCardless,  16 = McpePayPoint,  17 = GlobalPayments,  18 = EWayPayment,  19 = Stripe,  20 = BarclayCardEPdqExtraPlus,  21 = Square,  22 = IRISPay","required":true,"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,14,15,16,17,18,19,20,21,22]},{"name":"isPayonlineConfig","in":"query","description":"If set to true [is payonline configuration].","required":false,"type":"boolean"}],"responses":{"200":{"description":"The url for authorization in OAuth","schema":{"type":"string"}},"404":{"description":"No payment processor found, or the payment processor is deprecated"}},"deprecated":false}},"/paymentprocessors/{processorType}/transactions/{transactionId}/metadata":{"get":{"tags":["PaymentProcessor"],"summary":"Get the transaction metadata for the payment processor","operationId":"PaymentProcessor_GetTransactionMetadata","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"transactionId","in":"path","description":"The transaction identifier.","required":true,"type":"string"},{"name":"processorType","in":"path","description":"Type of the processor. 0 = NoCardPayments,  1 = SecureHosting,  2 = SagePay,  3 = IridiumCorp,  4 = Worldpay,  5 = ProcessingPoint,  6 = SagePaymentSolutions,  7 = SmartPay,  8 = AuthorizeDotNet,  9 = PayPalPro,  10 = PaymentSense,  11 = CardSave,  12 = CardStream,  14 = BarclayCardEPdq,  15 = GoCardless,  16 = McpePayPoint,  17 = GlobalPayments,  18 = EWayPayment,  19 = Stripe,  20 = BarclayCardEPdqExtraPlus,  21 = Square,  22 = IRISPay","required":true,"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,14,15,16,17,18,19,20,21,22]}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/KashFlow.Accounting.Business.Payment.Model.TransactionMetadata"}},"404":{"description":"No processor or transaction found"}},"deprecated":false}},"/paymentstatuses":{"get":{"tags":["PaymentStatus"],"summary":"Get a list of payment statuses","operationId":"PaymentStatus_GetPaymentStatuses","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.Util.EnumValue"}}}},"deprecated":false}},"/internal/{objectType}/{number}/payments/{paymentId}/unallocate":{"post":{"tags":["PaymentUnallocation"],"summary":"Remove the allocation of a payment from an entity","operationId":"PaymentUnallocation_UnallocateInvoicePayment","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"objectType","in":"path","description":"Type: \"invoices\" or \"purchases\"","required":true,"type":"string"},{"name":"number","in":"path","description":"Number","required":true,"type":"integer","format":"int32"},{"name":"paymentId","in":"path","description":"PaymentId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.PaymentUnallocation.PaymentUnallocationResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Not Found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/payonline/{invoiceId}":{"get":{"tags":["PayOnline"],"summary":"Get the PayOnline information for the selected invoice","operationId":"PayOnline_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"invoiceId","in":"path","description":"Invoice Id","required":true,"type":"integer","format":"int32"},{"name":"token","in":"query","description":"Token (Guid) sent in email","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.InvoicePayOnline"}},"404":{"description":"Payonline not found or invalid payment"}},"deprecated":false}},"/payonline/{processorType}":{"post":{"tags":["PayOnline"],"summary":"Receive a Payment Card Industry (PCI) payment via PayOnline","operationId":"PayOnline_ProcessorPCIPayOnlineAsync","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"paymentDetails","in":"body","description":"The payment details.","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Payment.PaymentDetails"}},{"name":"processorType","in":"path","description":"Type of the processor. 0 = NoCardPayments,  1 = SecureHosting,  2 = SagePay,  3 = IridiumCorp,  4 = Worldpay,  5 = ProcessingPoint,  6 = SagePaymentSolutions,  7 = SmartPay,  8 = AuthorizeDotNet,  9 = PayPalPro,  10 = PaymentSense,  11 = CardSave,  12 = CardStream,  14 = BarclayCardEPdq,  15 = GoCardless,  16 = McpePayPoint,  17 = GlobalPayments,  18 = EWayPayment,  19 = Stripe,  20 = BarclayCardEPdqExtraPlus,  21 = Square,  22 = IRISPay","required":true,"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,14,15,16,17,18,19,20,21,22]},{"name":"userId","in":"query","description":"The user identifier.","required":true,"type":"integer","format":"int32"}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Payment.CardPaymentResponse"}},"400":{"description":"When recaptcha token is invalid"},"404":{"description":"No processor found with that name"}},"deprecated":false}},"/payonline/globalpayments/iframe":{"post":{"tags":["PayOnline"],"summary":"Set the Global Payments configuration details for the PayOnline service","operationId":"PayOnline_GlobalPaymentsIframeConfiguration","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"iframeData","in":"body","description":"The payment details.","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Payment.GlobalPayments.IframeData"}},{"name":"userId","in":"query","description":"The user identifier.","required":true,"type":"integer","format":"int32"},{"name":"invoiceId","in":"query","description":"","required":true,"type":"integer","format":"int32"},{"name":"token","in":"query","description":"","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Payment.CardPaymentResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/payonline/result":{"get":{"tags":["PayOnline"],"summary":"Decrypt the PayOnline secret key","operationId":"PayOnline_GetResultFromIframePayment","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"secret","in":"query","required":true,"type":"string"}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Payment.CardPaymentResponse"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No processor found with that name"}},"deprecated":false}},"/payonline/worldpay/secret":{"get":{"tags":["PayOnline"],"summary":"Get the Worldpay secret key for the PayOnline service","operationId":"PayOnline_WorldpaySecretConfiguration","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"userId","in":"query","description":"The user identifier","required":true,"type":"integer","format":"int32"},{"name":"invoiceNumber","in":"query","description":"The number against which invoice is to be fetched","required":true,"type":"integer","format":"int32"},{"name":"token","in":"query","description":"Token (Guid) sent in email","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}},"deprecated":false}},"/payonline/worldpay/signature":{"post":{"tags":["PayOnline"],"summary":"Verify captcha and generate Md5 encrypted value from string","operationId":"PayOnline_VerifyCaptchaAndGenerateMD5Signature","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"userId","in":"query","description":"user id","required":true,"type":"integer","format":"int32"},{"name":"worldPayRequest","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Payment.Worldpay.WorldPayRequest"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}},"deprecated":false}},"/integration/paypal/setup":{"post":{"tags":["PayPal"],"summary":"To check whether paypal setup is done or not","operationId":"PayPal_Setup","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"payPalSetupRequest","in":"body","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.PayPal.PayPalSetupBase"}}],"responses":{"200":{"description":"PayPal setup completed succefully"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/integration/paypal/authorise":{"put":{"tags":["PayPal"],"summary":"To check whether paypal is authorised or not","operationId":"PayPal_Authorise","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"payPalSetupRequest","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.PayPal.PayPalSetupRequest"}}],"responses":{"200":{"description":"PayPal authorization completed succefully"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/integration/paypal/profile":{"get":{"tags":["PayPal"],"summary":"To get PayPal profile settings","operationId":"PayPal_GetSettings","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"profileId","in":"query","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"PayPal profile settings fetched successfully","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.PayPal.PayPalProfileSettings"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"put":{"tags":["PayPal"],"summary":"Updates PayPal profile settings.Triggers re-import when reimport=true.","operationId":"PayPal_UpdateSettings","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"profileId","in":"query","description":"PayPal profile id","required":true,"type":"integer","format":"int32"},{"name":"settings","in":"body","description":"Settings payload","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.PayPal.PayPalProfileSettings"}},{"name":"reimport","in":"query","description":"Set true to trigger re-import","required":false,"type":"boolean"},{"name":"startDate","in":"query","description":"Start date for re-import in yyyyMMddHHmmss format","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"PayPal profile settings updated successfully","schema":{"type":"boolean"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/integration/paypal/{profileId}":{"delete":{"tags":["PayPal"],"summary":"Delete profile","operationId":"PayPal_DeleteProfile","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"profileId","in":"path","description":"Profile Id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"PayPal profile deleted successfully","schema":{"type":"boolean"}}},"deprecated":false}},"/integration/paypal/country":{"get":{"tags":["PayPal"],"summary":"Get the country list","operationId":"PayPal_GetCountries","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Core.Model.Country"}}}},"deprecated":false}},"/integration/paypal/setup-config":{"post":{"tags":["PayPal"],"summary":"setup config","operationId":"PayPal_SetupConfig","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"setupConfigRequest","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.PayPal.SetupConfig"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.PayPal.SetupConfig"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/internal/payrollactivation":{"post":{"tags":["PayrollActivation"],"summary":"Set the provisioning status of the payroll application (The visibility of the payroll modal depends on this setting)","operationId":"PayrollActivation_ActivatePayroll","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/documents/{documentType}/bulk/{id}":{"get":{"tags":["PermaLink"],"summary":"Generate multiple PDFs for an entity","operationId":"PermaLink_GetDocumentFile","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"documentType","in":"path","description":"Type of the document. 0 = Invoice,  1 = PackingSlip,  2 = Quote,  3 = RemittanceAdvice,  4 = PaymentReceipt,  5 = Purchase,  6 = CustomerStatement,  7 = SupplierStatement,  8 = ReminderLetter,  9 = PO,  10 = InvoiceBatchPayment,  11 = PurchaseBatchPayment","required":true,"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,9,10,11]},{"name":"id","in":"path","description":"The document identifier.","required":true,"type":"string"},{"name":"token","in":"query","description":"The document token. (Required)","required":false,"type":"string"},{"name":"media","in":"query","description":"The media. 0 = Print,  1 = Email,  2 = ViaPost","required":false,"type":"integer","format":"int32","enum":[0,1,2]},{"name":"theme","in":"query","description":"The theme.","required":false,"type":"integer","format":"int32"},{"name":"startdate","in":"query","description":"The startdate.","required":false,"type":"string"},{"name":"enddate","in":"query","description":"The enddate.","required":false,"type":"string"},{"name":"excludepaid","in":"query","description":"The excludepaid.","required":false,"type":"integer","format":"int32"},{"name":"excludeCustOB","in":"query","description":"The exclude customer ob.","required":false,"type":"integer","format":"int32"},{"name":"filterby","in":"query","description":"The filterby.","required":false,"type":"string"},{"name":"order","in":"query","description":"The order.","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"The sort by.","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/documents/{documentType}/{id}":{"get":{"tags":["PermaLink"],"summary":"Generate a single PDF for an entity","operationId":"PermaLink_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"documentType","in":"path","description":"The document type. 0 = Invoice,  1 = PackingSlip,  2 = Quote,  3 = RemittanceAdvice,  4 = PaymentReceipt,  5 = Purchase,  6 = CustomerStatement,  7 = SupplierStatement,  8 = ReminderLetter,  9 = PO,  10 = InvoiceBatchPayment,  11 = PurchaseBatchPayment","required":true,"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,9,10,11]},{"name":"id","in":"path","description":"The document identifier.","required":true,"type":"string"},{"name":"token","in":"query","description":"Document Token","required":false,"type":"string"},{"name":"startdate","in":"query","description":"Start Date","required":false,"type":"string"},{"name":"enddate","in":"query","description":"End Date","required":false,"type":"string"},{"name":"excludepaid","in":"query","description":"Exclude Paid","required":false,"type":"integer","format":"int32"},{"name":"excludecustob","in":"query","description":"Exclude Opening Balance","required":false,"type":"integer","format":"int32"},{"name":"media","in":"query","description":"Media 0 = Print,  1 = Email,  2 = ViaPost","required":false,"type":"integer","format":"int32","enum":[0,1,2]},{"name":"theme","in":"query","description":"Theme","required":false,"type":"integer","format":"int32"},{"name":"filterby","in":"query","description":"FilterBy","required":false,"type":"string"},{"name":"outputtype","in":"query","description":"outputType","required":false,"type":"integer","format":"int32"},{"name":"batchpaymentnumber","in":"query","description":"BatchPaymentNumber","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"The document file (PDF or HTML)"}},"deprecated":false}},"/documents/invoice/payment/{id}":{"get":{"tags":["PermaLink"],"summary":"Get a PDF of the invoice payment","operationId":"PermaLink_GetInvoicePayment","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The document identifier.","required":true,"type":"string"},{"name":"token","in":"query","description":"The document token.","required":false,"type":"string"},{"name":"documentMedia","in":"query","description":"The media. 0 = Print,  1 = Email,  2 = ViaPost","required":false,"type":"integer","format":"int32","enum":[0,1,2]},{"name":"theme","in":"query","description":"The theme.","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"The document file (PDF)"}},"deprecated":false}},"/documents/purchase/payment/{id}":{"get":{"tags":["PermaLink"],"summary":"Get a PDF of the purchase payment","operationId":"PermaLink_GetPurchasePayment","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The document identifier. (Required)","required":true,"type":"string"},{"name":"token","in":"query","description":"The document token.","required":false,"type":"string"},{"name":"documentMedia","in":"query","description":"The media. 0 = Print,  1 = Email,  2 = ViaPost","required":false,"type":"integer","format":"int32","enum":[0,1,2]},{"name":"theme","in":"query","description":"The theme.","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"The document file (PDF)"}},"deprecated":false}},"/userpermissions":{"get":{"tags":["Permission"],"summary":"Get the user permissions","operationId":"Permission_GetUserPermissionList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/userpermissions-mobile":{"get":{"tags":["Permission"],"summary":"Get the user permissions for mobile app","operationId":"Permission_GetUserPermissionListForMobile","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/permissionhierarchy":{"get":{"tags":["PermissionHierarchy"],"summary":"Get the Permission Hierarchy","operationId":"PermissionHierarchy_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/products":{"get":{"tags":["Product"],"summary":"Get the product list","operationId":"Product_GetList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Product.ProductResponse"}}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["Product"],"summary":"This API allows a developer to create a new product.","operationId":"Product_CreateProduct","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"productRequest","in":"body","description":"Product details","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Product.ProductRequest"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Product.ProductDetailsResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/products/list":{"get":{"tags":["Product"],"summary":"This API allows a developer to retrieve a list of products available in specific IRIS KashFlow account. .","operationId":"Product_GetListOfAllProduct","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"page","in":"query","description":"The page number to be retrieved. The default value is 1.","required":false,"type":"integer","format":"int32"},{"name":"perpage","in":"query","description":"The number of records to be returned in a page. The default value is 10. Maximum allowed records per page are 100.","required":false,"type":"integer","format":"int32"},{"name":"order","in":"query","description":"Whether you want to sort the records in ascending (Asc) or descending (Desc) order. The default sort order is ascending (Asc)","required":false,"type":"string"},{"name":"sortcolumn","in":"query","description":"The field using which you would like to sort. Available options are:\r\n            0 = Product Code\r\n            1 =Product Name\r\n            2 = Nominal Code\r\n            default is 0 i.e., product code 0 = ProductCode,  1 = ProductName,  2 = NominalCode","required":false,"type":"integer","format":"int32","enum":[0,1,2]},{"name":"filterbycharacter","in":"query","description":"Provide this when you want to retrieve products whose name starts with given string.","required":false,"type":"string"},{"name":"filterbyinuseonly","in":"query","description":"Flag to indicate whether to include in use products or all. Default is true i.e., in use products are retrieved","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Product.ProductResponse"}}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/nominals/{nominalcode}/products":{"get":{"tags":["Product"],"summary":"This API allows a developer to retrieve a list of products available under a specific nominal in specific IRIS KashFlow account.","operationId":"Product_GetPage","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"nominalcode","in":"path","description":"Nominal Code. Unique code used to represent a nominal/chart of account in your system for which you want to retrieve products.","required":true,"type":"integer","format":"int32"},{"name":"page","in":"query","description":"The page number to be retrieved. The default value is 1.","required":false,"type":"integer","format":"int32"},{"name":"perpage","in":"query","description":"The number of records to be returned in a page. The default value is 10. Maximum allowed records per page are 100.","required":false,"type":"integer","format":"int32"},{"name":"order","in":"query","description":"Whether you want to sort the records in ascending (Asc) or descending (Desc) order. The default sort order is ascending (Asc)","required":false,"type":"string"},{"name":"sortcolumn","in":"query","description":"The field using which you would like to sort. Available options are:\r\n            0 = Product Code\r\n            1 =Product Name\r\n            2 = Nominal Code\r\n            default is 0 i.e., product code 0 = ProductCode,  1 = ProductName,  2 = NominalCode","required":false,"type":"integer","format":"int32","enum":[0,1,2]},{"name":"filterbycharacter","in":"query","description":"Provide this when you want to retrieve products whose name starts with given string.","required":false,"type":"string"},{"name":"filterbyinuseonly","in":"query","description":"Flag to indicate whether to include in use products or all. Default is true i.e., in use products are retrieved","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Paging[KashFlow.Accounting.DTO.Product.ProductResponse]"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/products/{nominalCode}/{code}":{"get":{"tags":["Product"],"summary":"Get product details, by code","operationId":"Product_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"nominalCode","in":"path","description":"Nominal code","required":true,"type":"integer","format":"int32"},{"name":"code","in":"path","description":"Product code","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Product.ProductDetailsResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No product found with that code"}},"deprecated":false},"put":{"tags":["Product"],"summary":"Update an product","operationId":"Product_Update","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"nominalCode","in":"path","description":"Nominal code","required":true,"type":"integer","format":"int32"},{"name":"code","in":"path","description":"Product code which needs to be updated","required":true,"type":"string"},{"name":"productRequest","in":"body","description":"Product details to be updated","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Product.ProductUpdateRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Product.ProductDetailsUpdateResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No product found with that code"}},"deprecated":false},"delete":{"tags":["Product"],"summary":"Delete a product by code","operationId":"Product_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"nominalCode","in":"path","description":"Nominal code of product to be deleted","required":true,"type":"integer","format":"int32"},{"name":"code","in":"path","description":"Product code","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted product"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No product found"}},"deprecated":false}},"/reports/profitandloss":{"get":{"tags":["ProfitAndLossReport"],"summary":"This API allows a developer to get Profit and Loss report. It lists your Turnover less your Cost of Sales to give you your Gross Profit. Expenses are then subtracted from your Gross Profit to give you your net profit.","operationId":"ProfitAndLossReport_GetReportForUser","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"startDate","in":"query","description":"Start date from which the P and L report is to be fetched","required":true,"type":"string","format":"date-time"},{"name":"endDate","in":"query","description":"End date till which the P and L report is to be fetched","required":true,"type":"string","format":"date-time"},{"name":"projectId","in":"query","description":"Use this when you want to filter transactions by Project. Specify the Project ID whose transactions you want to consider in the report","required":false,"type":"integer","format":"int32"},{"name":"excludeYearEnd","in":"query","description":"Flag to indicate whether to exclude or include year-end journal. Default is false. i.e., year-end journals are included.","required":false,"type":"boolean"},{"name":"excludeZeroBalance","in":"query","description":"Flag to indicate whether to exclude or include nominals with zero balance transactions. Default is true i.e., zero balance nominals are excluded.","required":false,"type":"boolean"},{"name":"showBreakdown","in":"query","description":"Flag to indicate whether to show or hide breakdown. Default is false. i.e., breakdown is not shown.","required":false,"type":"boolean"},{"name":"accountingType","in":"query","description":"Accounting type 0 = Cash,  1 = Accrual","required":false,"type":"integer","format":"int32","enum":[0,1]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.ProfitAndLossReport.ProfitAndLossReport"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/reports/profitandloss/monthly-profit-loss":{"get":{"tags":["ProfitAndLossReport"],"summary":"Get monthly profit and loss report within the date range passed.","operationId":"ProfitAndLossReport_GetMonthlyProfitAndLoss","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"startdate","in":"query","required":true,"type":"string"},{"name":"enddate","in":"query","required":true,"type":"string"},{"name":"projectnumber","in":"query","required":false,"type":"integer","format":"int32"},{"name":"accountingtype","in":"query","description":" 0 = Cash,  1 = Accrual","required":false,"type":"integer","format":"int32","enum":[0,1]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.ProfitAndLossReport.MonthlyProfitAndLoss"}}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/reports/profitandloss/monthly-profit-loss-csv":{"get":{"tags":["ProfitAndLossReport"],"summary":"Get monthly profit and loss breakdown for csv.","operationId":"ProfitAndLossReport_GetMonthlyProfitLossBreakdown","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"roundoff","in":"query","required":false,"type":"boolean"},{"name":"startdate","in":"query","required":true,"type":"string"},{"name":"enddate","in":"query","required":true,"type":"string"},{"name":"projectnumber","in":"query","required":false,"type":"integer","format":"int32"},{"name":"accountingtype","in":"query","description":" 0 = Cash,  1 = Accrual","required":false,"type":"integer","format":"int32","enum":[0,1]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.ProfitAndLossReportCsv.MonthlyProfitLossBreakdown"}}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/projects":{"get":{"tags":["Project"],"summary":"This API allows a developer to retrieve a list of projects available in specific IRIS KashFlow account.","operationId":"Project_GetList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"page","in":"query","required":false,"type":"integer","format":"int32"},{"name":"perpage","in":"query","required":false,"type":"integer","format":"int32"},{"name":"sort","in":"query","description":" 0 = Asc,  1 = Desc","required":false,"type":"integer","format":"int32","enum":[0,1]},{"name":"sortby","in":"query","description":" 0 = Number,  1 = Name,  2 = Reference,  3 = Customer,  4 = Status,  5 = Margin,  6 = Id","required":false,"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6]},{"name":"status","in":"query","required":false,"type":"array","items":{"type":"string"}},{"name":"searchtext","in":"query","required":false,"type":"string"},{"name":"number","in":"query","required":false,"type":"integer","format":"int32"},{"name":"name","in":"query","required":false,"type":"string"},{"name":"ref","in":"query","required":false,"type":"string"},{"name":"description","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Paging[KashFlow.Accounting.DTO.Project.ProjectListResponse]"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["Project"],"summary":"This API allows a developer to create a new customer.","operationId":"Project_Create","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"projectRequest","in":"body","description":"Project details","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Project.ProjectRequest"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Project.ProjectResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/customers/{code}/projects":{"get":{"tags":["Project"],"summary":"This API allows a developer to retrieve a list of projects available in specific IRIS KashFlow account for given customer code.","operationId":"Project_GetCustomerProjects","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"code","in":"path","description":"Customer Code. Unique code used to represent a customer in your system for which you want to retrieve projects.","required":true,"type":"string"},{"name":"page","in":"query","description":"The page number to be retrieved. The default value is 1.","required":false,"type":"integer","format":"int32"},{"name":"perPage","in":"query","description":"The number of records to be returned in a page. The default value is 10. Maximum allowed records per page are 100.","required":false,"type":"integer","format":"int32"},{"name":"sortBy","in":"query","description":"The field using which you would like to sort. Available options are:\r\n              0 = Number\r\n              1 = Reference\r\n              2 = Name\r\n              3 = Status\r\n              Default is name Number 0 = Number,  1 = Name,  2 = Reference,  3 = Customer,  4 = Status,  5 = Margin,  6 = Id","required":false,"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6]},{"name":"order","in":"query","description":"Whether you want to sort the records in ascending (Asc) or descending (Desc) order. The default sort order is ascending (Asc)","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Paging[KashFlow.Accounting.DTO.Project.ProjectListResponse]"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No customer found with that code"}},"deprecated":false}},"/projects/{number}":{"get":{"tags":["Project"],"summary":"This API allows a developer to retrieve details for a particular project with the given number.","operationId":"Project_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"Project number. Unique code used to represent a project in your system for which you want to retrieve details.","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Project.ProjectResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No projects found"}},"deprecated":false},"put":{"tags":["Project"],"summary":"This API allows a developer to modify an existing project by number.","operationId":"Project_Update","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"Project number","required":true,"type":"integer","format":"int32"},{"name":"projectRequest","in":"body","description":"Project details","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Project.ProjectRequest"}}],"responses":{"200":{"description":"Project was updated","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Project.ProjectResponse"}},"201":{"description":"Project updated with new number","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Project.ProjectResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No projects found"}},"deprecated":false},"delete":{"tags":["Project"],"summary":"This API allows a developer to delete existing project with given number.","operationId":"Project_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"Old unique number used to represent a project in system which you want to delete.\r\n             Project with given number must exists in system.","required":true,"type":"integer","format":"int32"},{"name":"reassignprojectnumber","in":"query","description":"New unique number used to represent a project in system to which you want to assign existing transactions under old, deleted project.\r\n             Project with given number must exists in system.","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"Deleted project"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No projects found"}},"deprecated":false}},"/projects/archive-status/{isArchived}":{"put":{"tags":["Project"],"summary":"Bulk update archive status for projects","operationId":"Project_UpdateProjectArchiveStatus","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"isArchived","in":"path","description":"True to archive, false to unarchive","required":true,"type":"boolean"},{"name":"projectNumbers","in":"body","description":"List of unique number used to represent a project in system which you want to archive","required":true,"schema":{"type":"array","items":{"format":"int32","type":"integer"}}}],"responses":{"200":{"description":"Project numbers updated","schema":{"type":"array","items":{"format":"int32","type":"integer"}}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/projectlist":{"delete":{"tags":["Project"],"summary":"This API allows a developer to delete multiple projects with given numbers.","operationId":"Project_DeleteProjects","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"projectNumbers","in":"body","description":"List of project numbers to be deleted. Projects with given numbers must exist in the system.","required":true,"schema":{"type":"array","items":{"format":"int32","type":"integer"}}},{"name":"reassignProjectNumber","in":"query","description":"New unique number used to represent a project in the system to which you want to assign existing transactions under the deleted projects.  \r\n            If 0 or not provided, transactions will not be reassigned. If provided, project with the given number must exist in the system and must be greater than zero.","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Projects deleted successfully","schema":{"type":"string"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"One or more projects not found"}},"deprecated":false}},"/subscription/promo":{"get":{"tags":["Promo"],"summary":"Get the promotion code applied to a subscription","operationId":"Promo_GetPromoDetails","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.UserSubscription.Promo"}}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"put":{"tags":["Promo"],"summary":"Change the promotion code applied to a subscription","operationId":"Promo_ApplyPromoCode","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"promoCode","in":"query","description":"Promotion Code","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.UserSubscription.SubscriptionInfo"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/purchases":{"get":{"tags":["Purchase"],"summary":"Get a list of purchases for the selected company","operationId":"Purchase_GetPage","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"page","in":"query","description":"Page number. (default is 1)","required":false,"type":"integer","format":"int32"},{"name":"perpage","in":"query","description":"PerPage is number of records per page. (default is 50)","required":false,"type":"integer","format":"int32"},{"name":"order","in":"query","description":"Sorting order (asc or desc) (default is asc)","required":false,"type":"string"},{"name":"sortby","in":"query","description":"Sort By column/field name. (default is Number) 0 = Number,  1 = SupplierReference,  2 = SupplierName,  3 = PurchaseDate,  4 = PaymentDueDate,  5 = GrossAmount,  6 = NetAmount,  7 = Status,  8 = PaidDate,  9 = DueAmount,  10 = Type,  11 = Project,  12 = VAT","required":false,"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12]},{"name":"filterby","in":"query","description":"Status Filter","required":false,"type":"string"},{"name":"projectnumber","in":"query","description":"Project Number","required":false,"type":"integer","format":"int32"},{"name":"suppliercode","in":"query","description":"Supplier code","required":false,"type":"string"},{"name":"searchtext","in":"query","description":"Search text","required":false,"type":"string"},{"name":"type","in":"query","description":"Filter by type Purchase/Expense","required":false,"type":"string"},{"name":"issuedatefrom","in":"query","description":"For issue date filter","required":false,"type":"string"},{"name":"issuedateto","in":"query","description":"For issue date filter","required":false,"type":"string"},{"name":"source","in":"query","description":"Send \"MatchingEngine\" if request has been sent from matching engine otherwise empty(\"\")","required":false,"type":"string"},{"name":"dosearchwithdueamount","in":"query","description":"For search with due amount","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Paging[KashFlow.Accounting.DTO.Purchase.PurchaseListResponse]"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["Purchase"],"summary":"Create purchase","operationId":"Purchase_Create","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"purchaseRequest","in":"body","description":"Purchase details","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Purchase.PurchaseRequest"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Purchase.PurchaseResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/purchases/topdue":{"get":{"tags":["Purchase"],"summary":"Get the list of purchases, by due date ascending","operationId":"Purchase_GetTopDue","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"suppliercode","in":"query","description":"The suppliercode.","required":false,"type":"string"},{"name":"searchText","in":"query","description":"The search text.","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.PurchaseSummary"}}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No supplier found with that code"}},"deprecated":false}},"/purchases/{number}":{"get":{"tags":["Purchase"],"summary":"Get the purchase details, by ID","operationId":"Purchase_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"purchase number","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Purchase.PurchaseResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access ","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"put":{"tags":["Purchase"],"summary":"Update a purchase","operationId":"Purchase_Update","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"Purchase number which needs to be updated","required":true,"type":"integer","format":"int32"},{"name":"purchaseRequest","in":"body","description":"Purchase details to be updated","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Purchase.PurchaseRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Purchase.PurchaseResponse"}},"201":{"description":"Created purchase with new number","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Purchase.PurchaseResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"delete":{"tags":["Purchase"],"summary":"Delete a purchase","operationId":"Purchase_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"Purchase number to be deleted","required":true,"type":"integer","format":"int32"}],"responses":{"204":{"description":"Purchase deleted"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No Purchase found with that number"}},"deprecated":false}},"/purchases/{number}/reverse":{"post":{"tags":["Purchase"],"summary":"Reverse a purchase included in a submitted VAT return","operationId":"Purchase_Reverse","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"Unique identifier of the purchase","required":true,"type":"integer","format":"int32"}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Purchase.PurchaseResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/purchases/{number}/email":{"put":{"tags":["Purchase"],"summary":"Set the email flag as sent or unsent for the purchase","operationId":"Purchase_UpdateEmailFlag","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"purchase number","required":true,"type":"integer","format":"int32"},{"name":"isEmailSent","in":"query","description":"flag indicating if th email is sent","required":true,"type":"boolean"}],"responses":{"204":{"description":"Email Flag is set"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/purchaselist":{"post":{"tags":["Purchase"],"summary":"Create multiple purchases","operationId":"Purchase_BulkCreate","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"purchaseList","in":"body","description":"List of purchases","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Purchase"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Base.PurchaseMassCreateStatus"}}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No customer found with that code"}},"deprecated":false}},"/internal/purchases":{"put":{"tags":["Purchase"],"summary":"Assign a project to multiple purchase invoices","operationId":"Purchase_AssignProjectToPurchaseInvoices","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"assignproject","in":"query","description":"project number to be assifned","required":true,"type":"integer","format":"int32"},{"name":"purchaseNumbers","in":"body","description":"List of purchase invoices to update project","required":true,"schema":{"type":"array","items":{"format":"int32","type":"integer"}}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"Assigned project to purchase invoices"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["Purchase"],"summary":"Convert a purchase order to a purchase","operationId":"Purchase_ConvertEntities","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"convertfrom","in":"query","description":"entity to convert","required":true,"type":"string"},{"name":"entityNumbers","in":"body","description":"list of entity numbers to convert","required":true,"schema":{"type":"array","items":{"format":"int32","type":"integer"}}}],"responses":{"201":{"description":"Created","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.SourceAndDestination[System.Int32,System.Int32]"}}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/purchasescountforsubscriptioncycle":{"get":{"tags":["Purchase"],"summary":"Get invoice count for current user","operationId":"Purchase_GetPurchasesCreatedForSubscriptionCycle","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"format":"int32","type":"integer"}}},"deprecated":false}},"/purchases/option":{"get":{"tags":["Purchase"],"summary":"Get the purchase options","operationId":"Purchase_GetPurchaseOptions","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.PurchaseOptions"}}},"deprecated":false}},"/purchase/options":{"put":{"tags":["Purchase"],"summary":"Update purchase options","operationId":"Purchase_UpdatePurchaseOptions","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"purchaseOptions","in":"body","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.PurchaseOptions"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.PurchaseOptions"}}},"deprecated":false}},"/list":{"delete":{"tags":["Purchase"],"summary":"Delete multiple purchase invoices/expenses","operationId":"Purchase_DeleteBulkInvoices","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"purchaseInvoice","in":"body","description":"List of invoice numbers to be deleted","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.BulkPurchaseRequest"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"204":{"description":"Deleted invoices"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/purchaseorders":{"get":{"tags":["PurchaseOrder"],"summary":"Get a list of purchase orders","operationId":"PurchaseOrder_GetPaginatedList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"page","in":"query","description":"Page number. (default is 1)","required":false,"type":"integer","format":"int32"},{"name":"perpage","in":"query","description":"PerPage is number of records per page. (default is 50)","required":false,"type":"integer","format":"int32"},{"name":"order","in":"query","description":"Sorting order (asc or desc) (default is asc)","required":false,"type":"string"},{"name":"sortby","in":"query","description":"Sort By column/field name. (default is Number)","required":false,"type":"string"},{"name":"projectnumber","in":"query","description":"Project Number","required":false,"type":"integer","format":"int32"},{"name":"suppliercode","in":"query","description":"Supplier Code","required":false,"type":"string"},{"name":"categorynumber","in":"query","description":"Purchase order Category Number","required":false,"type":"integer","format":"int32"},{"name":"issuedatefrom","in":"query","description":"Issue Date From","required":false,"type":"string"},{"name":"issuedateto","in":"query","description":"Issue Date To","required":false,"type":"string"},{"name":"searchtext","in":"query","description":"Search Text by Purchase order's Number or Reference","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Paging[KashFlow.Accounting.DTO.PurchaseOrder.PurchaseOrderListResponse]"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["PurchaseOrder"],"summary":"Create a purchase order","operationId":"PurchaseOrder_Create","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"purchaseOrderRequest","in":"body","description":"purchaseorder details","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.PurchaseOrder.PurchaseOrderRequest"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.PurchaseOrder.PurchaseOrderResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/purchaseorders/{number}":{"get":{"tags":["PurchaseOrder"],"summary":"Get the purchase order details, by ID","operationId":"PurchaseOrder_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"purchaseorder number","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.PurchaseOrder.PurchaseOrderResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No PurchaseOrder found with that number"}},"deprecated":false},"put":{"tags":["PurchaseOrder"],"summary":"Update a purchase order","operationId":"PurchaseOrder_Update","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"purchaseOrder number","required":true,"type":"integer","format":"int32"},{"name":"purchaseOrderRequest","in":"body","description":"purchaseOrder details","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.PurchaseOrder.PurchaseOrderRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.PurchaseOrder.PurchaseOrderResponse"}},"201":{"description":"Purchaseorder updated","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.PurchaseOrder.PurchaseOrderResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"delete":{"tags":["PurchaseOrder"],"summary":"Delete a purchase order","operationId":"PurchaseOrder_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"PurchaseOrder number to be deleted","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"format":"int32","type":"integer"}},"204":{"description":"PurchaseOrder deleted"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No PurchaseOrder found with that number"}},"deprecated":false}},"/purchaseorders/{number}/email":{"put":{"tags":["PurchaseOrder"],"summary":"Set the email flag as sent or unsent for the purchase order","operationId":"PurchaseOrder_UpdateEmailFlag","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"purchase number","required":true,"type":"integer","format":"int32"},{"name":"isEmailSent","in":"query","description":"flag indicating if th email is sent","required":true,"type":"boolean"}],"responses":{"204":{"description":"Email Flag is set"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/purchaseorderlist":{"delete":{"tags":["PurchaseOrder"],"summary":"Delete multiple purchase orders","operationId":"PurchaseOrder_DeletePurchaseOrders","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"purchaseOrdersNumbers","in":"body","description":"Purchase Order Number list","required":true,"schema":{"type":"array","items":{"format":"int32","type":"integer"}}}],"responses":{"204":{"description":"Deleted Purchase Orders"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"PurchaseOrder not found with the provided numbers"}},"deprecated":false}},"/purchaseordercategories":{"get":{"tags":["PurchaseOrderCategory"],"summary":"Get a list of purchase order categories","operationId":"PurchaseOrderCategory_GetList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.PurchaseOrderCategory"}}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["PurchaseOrderCategory"],"summary":"Create a purchase order category","operationId":"PurchaseOrderCategory_Create","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"category","in":"body","description":"Purchase order category details","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.PurchaseOrderCategory"}}],"responses":{"201":{"description":"Created","schema":{"format":"int32","type":"integer"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/purchaseordercategories/{number}":{"put":{"tags":["PurchaseOrderCategory"],"summary":"Update Purchase Order Category","operationId":"PurchaseOrderCategory_Update","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"Purchase order category number which needs to be updated","required":true,"type":"integer","format":"int32"},{"name":"category","in":"body","description":"Purchase order category details to be updated","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.PurchaseOrderCategory"}}],"responses":{"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"delete":{"tags":["PurchaseOrderCategory"],"summary":"Delete a purchase order category, by ID","operationId":"PurchaseOrderCategory_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"Purchase order category number to be deleted","required":true,"type":"integer","format":"int32"}],"responses":{"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/purchaseordercategories/defaults":{"post":{"tags":["PurchaseOrderCategory"],"summary":"Create a default purchase order category","operationId":"PurchaseOrderCategory_CreateDefaults","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"201":{"description":"Created","schema":{"type":"boolean"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/purchaseordercategories/categorieslist":{"put":{"tags":["PurchaseOrderCategory"],"summary":"Update a Purchase Order category in a bulk","operationId":"PurchaseOrderCategory_UpdateCategories","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"categories","in":"body","description":"List of Purchase Order Category to be updated","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Wrapper.CategoryWrapper"}}],"responses":{"200":{"description":"Updated Purchase Order Categories"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["PurchaseOrderCategory"],"summary":"Create bulk purchase order category","operationId":"PurchaseOrderCategory_AddCategories","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"categories","in":"body","description":"The list of quote category to be created","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Wrapper.CategoryWrapper"}}],"responses":{"201":{"description":"Created Purchase Order Category"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/settings/purchaseorder":{"get":{"tags":["PurchaseOrderSetting"],"summary":"Get the purchase order settings","operationId":"PurchaseOrderSetting_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.PurchaseOrderSetting"}}},"deprecated":false},"put":{"tags":["PurchaseOrderSetting"],"summary":"Update the purchase order settings","operationId":"PurchaseOrderSetting_Update","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"purchaseOrderSetting","in":"body","description":"PurchaseOrderSetting object","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.PurchaseOrderSetting"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.PurchaseOrderSetting"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["PurchaseOrderSetting"],"summary":"Create an initial purchase order setting","operationId":"PurchaseOrderSetting_Create","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"purchaseOrderSetting","in":"body","description":"PurchaseOrderSetting object","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.PurchaseOrderSetting"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.PurchaseOrderSetting"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/reports/purchase/unallocated-supplier-payment":{"get":{"tags":["PurchaseReport"],"summary":"Get the Unallocated Supplier Payments Report","operationId":"PurchaseReport_GetUnallocatedSupplierPaymentReport","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"suppliercode","in":"query","required":false,"type":"string"},{"name":"startdate","in":"query","required":true,"type":"string"},{"name":"enddate","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.UnallocatedSupplierPaymentReports"}}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/reports/purchase/expenditure":{"get":{"tags":["PurchaseReport"],"summary":"Get expenditure report by expenditure type","operationId":"PurchaseReport_GetExpenditureReport","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"expenditureby","in":"query","description":" 0 = None,  1 = Supplier,  2 = PurchaseCode,  3 = SubPurchaseCode,  4 = PurchaseCodeByMonth,  5 = Monthly","required":false,"type":"integer","format":"int32","enum":[0,1,2,3,4,5]},{"name":"basedon","in":"query","description":" 0 = Issued,  1 = Paid","required":false,"type":"integer","format":"int32","enum":[0,1]},{"name":"projectid","in":"query","required":false,"type":"integer","format":"int32"},{"name":"nominalcode","in":"query","required":false,"type":"integer","format":"int32"},{"name":"includeexpensesuppliers","in":"query","required":false,"type":"boolean"},{"name":"includebankpayments","in":"query","required":false,"type":"boolean"},{"name":"startdate","in":"query","required":true,"type":"string"},{"name":"enddate","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"object","additionalProperties":{"format":"double","type":"number"}}}},"deprecated":false}},"/reports/purchase/expenditure-by-payment-method":{"get":{"tags":["PurchaseReport"],"summary":"GET Expenditure by payment method report","operationId":"PurchaseReport_GetExpenditureByPaymentMethod","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"paymentmethod","in":"query","required":false,"type":"integer","format":"int32"},{"name":"includebankpayment","in":"query","required":false,"type":"boolean"},{"name":"pagenumber","in":"query","required":false,"type":"integer","format":"int32"},{"name":"perpage","in":"query","required":false,"type":"integer","format":"int32"},{"name":"sortby","in":"query","description":" 0 = Date,  1 = Reference,  2 = Note,  3 = Amount,  4 = SupplierName,  5 = AccountNumber,  6 = SortCode","required":false,"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6]},{"name":"orderby","in":"query","required":false,"type":"string"},{"name":"startdate","in":"query","required":true,"type":"string"},{"name":"enddate","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Paging[KashFlow.Accounting.Model.Reports.PurchaseReport.GetExpenditureByPaymentMethodReportResponse]"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/reports/purchase/suppliers":{"get":{"tags":["PurchaseReport"],"summary":"Get supplier report","operationId":"PurchaseReport_GetSupplierReport","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"allsuppliers","in":"query","required":false,"type":"boolean"},{"name":"includearchivedsuppliers","in":"query","required":false,"type":"boolean"},{"name":"startdate","in":"query","required":false,"type":"string"},{"name":"enddate","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.PurchaseReport.SupplierReport.SupplierReportResponse"}}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/reports/purchase/expenditure-report-subpurchasecode-csv":{"get":{"tags":["PurchaseReport"],"summary":"Get Expenditure by Sub Purchase Code Report - CSV download","operationId":"PurchaseReport_GetExpenditureSubPurchaseCodeReportCsv","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"basedon","in":"query","description":" 0 = Issued,  1 = Paid","required":false,"type":"integer","format":"int32","enum":[0,1]},{"name":"projectnumber","in":"query","required":false,"type":"integer","format":"int32"},{"name":"startdate","in":"query","required":true,"type":"string"},{"name":"enddate","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.PurchaseReport.ExpenditureReportSubPurchaseCodeCsv.ExpenditureBySubPurchaseCodeCsvResponse"}}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/quotes":{"get":{"tags":["Quote"],"summary":"Get a list of quotes for the selected company","operationId":"Quote_GetPage","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"skipPerPageValidation","in":"query","description":"Skip per page validation","required":false,"type":"boolean"},{"name":"page","in":"query","description":"Page number. (default is 1)","required":false,"type":"integer","format":"int32"},{"name":"perpage","in":"query","description":"PerPage is number of records per page. (default is 50)","required":false,"type":"integer","format":"int32"},{"name":"order","in":"query","description":"Sorting order (asc or desc) (default is asc)","required":false,"type":"string"},{"name":"sortby","in":"query","description":"Sort By column/field name. (default is Number)","required":false,"type":"string"},{"name":"customercode","in":"query","description":"Customer code","required":false,"type":"string"},{"name":"categorynumber","in":"query","description":"Quote Category Number","required":false,"type":"integer","format":"int32"},{"name":"projectnumber","in":"query","description":"Project Number","required":false,"type":"integer","format":"int32"},{"name":"issuedateto","in":"query","description":"For issue date filter","required":false,"type":"string"},{"name":"issuedatefrom","in":"query","description":"For issue date filter","required":false,"type":"string"},{"name":"searchtext","in":"query","description":"Quote Reference","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Paging[KashFlow.Accounting.DTO.Quote.QuoteListResponse]"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["Quote"],"summary":"Create a quote","operationId":"Quote_Create","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"quoteRequest","in":"body","description":"Quote details","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Quote.QuoteRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"201":{"description":"Created","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Quote.QuoteResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/quotes/{number}":{"get":{"tags":["Quote"],"summary":"Get the quote details, by ID","operationId":"Quote_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"quote number","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Quote.QuoteResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No quote found with that number"}},"deprecated":false},"put":{"tags":["Quote"],"summary":"Update a quote","operationId":"Quote_Update","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"quote number which needs to be updated","required":true,"type":"integer","format":"int32"},{"name":"quoteRequest","in":"body","description":"quote details to be updated","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Quote.QuoteRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Quote.QuoteResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No quote found with that number"}},"deprecated":false},"delete":{"tags":["Quote"],"summary":"Delete a quote","operationId":"Quote_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"quote number to be deleted","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"Quote deleted"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No quote found with that number"}},"deprecated":false}},"/quotes/{number}/email":{"put":{"tags":["Quote"],"summary":"Set the email flag as sent or unsent for the quote","operationId":"Quote_UpdateEmailFlag","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"","required":true,"type":"integer","format":"int32"},{"name":"isEmailSent","in":"query","description":"","required":true,"type":"boolean"}],"responses":{"204":{"description":"Email Flag is set"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/quotelist":{"delete":{"tags":["Quote"],"summary":"Delete multiple quotes","operationId":"Quote_DeleteQuotes","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"quoteNumbers","in":"body","description":"Quote numbers to be deleted","required":true,"schema":{"type":"array","items":{"format":"int32","type":"integer"}}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"Quotes deleted"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access ","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Quote not found with the provided numbers"}},"deprecated":false}},"/quotecategories":{"get":{"tags":["QuoteCategory"],"summary":"This API allows a developer to retrieve a list of quote categories available in specific IRIS KashFlow account.","operationId":"QuoteCategory_GetList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.QuoteCategory"}}},"401":{"description":"Unauthorized Access ","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["QuoteCategory"],"summary":"Create a quote category","operationId":"QuoteCategory_Create","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"quoteCategory","in":"body","description":"Quote Category Object","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.QuoteCategory"}}],"responses":{"201":{"description":"Created Quote Category"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/quotecategories/{number}":{"put":{"tags":["QuoteCategory"],"summary":"Update a quote category","operationId":"QuoteCategory_Update","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"Number","required":true,"type":"integer","format":"int32"},{"name":"quoteCategory","in":"body","description":"Quote Category Object","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.QuoteCategory"}}],"responses":{"200":{"description":"Updated Quote Category"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"delete":{"tags":["QuoteCategory"],"summary":"Delete a quote category","operationId":"QuoteCategory_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"Number","required":true,"type":"integer","format":"int32"}],"responses":{"204":{"description":"Deleted Quote Category"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/quotecategories/categorieslist":{"put":{"tags":["QuoteCategory"],"summary":"Update a quote category in a bulk","operationId":"QuoteCategory_UpdateCategories","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"quoteCategories","in":"body","description":"List of Quote Category to be updated","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Wrapper.QuoteCategoryWrapper"}}],"responses":{"200":{"description":"Updated Quote Categories"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["QuoteCategory"],"summary":"Create bulk quote category","operationId":"QuoteCategory_AddCategories","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"categories","in":"body","description":"The list of quote category to be created","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Wrapper.CategoryWrapper"}}],"responses":{"201":{"description":"Created Quote Category"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/reports/quotes":{"get":{"tags":["QuoteReport"],"summary":"This API allows a developer to get a list of quotations over a specified period.","operationId":"QuoteReport_GetList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"dateFrom","in":"query","description":"Start date from which the quotes to be retrieved","required":true,"type":"string","format":"date-time"},{"name":"dateTo","in":"query","description":"End date till which the quotes to be retrieved","required":true,"type":"string","format":"date-time"},{"name":"customer","in":"query","description":"Use this when you want to filter quotes for Customers whose code is same as given string","required":false,"type":"string"},{"name":"page","in":"query","description":"The page number to be retrieved. The default value is 1.","required":false,"type":"integer","format":"int32"},{"name":"pageSize","in":"query","description":"The number of records to be returned in a page. The default value is 20. Maximum allowed records per page are 100.","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Paging[KashFlow.Accounting.DTO.QuoteReportItem.QuoteReportItemResponse]"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/integrations/receiptbank":{"post":{"tags":["ReceiptBank"],"summary":"Integrate Receipt Bank with the IRIS KashFlow account","operationId":"ReceiptBank_Post","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"receiptBankUser","in":"body","description":"Receipt Bank User","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ReceiptBankUser"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/recurringbanktransaction":{"get":{"tags":["RecurringBankTransaction"],"summary":"Get a list of recurring bank transaction","operationId":"RecurringBankTransaction_GetPage","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"page","in":"query","description":"Page number. (default is 1)","required":false,"type":"integer","format":"int32"},{"name":"perpage","in":"query","description":"PerPage is number of records per page. (default is 50)","required":false,"type":"integer","format":"int32"},{"name":"order","in":"query","description":"Sorting order (asc or desc)","required":false,"type":"string"},{"name":"filterby","in":"query","description":"Filter By 0 = All,  1 = Monthly,  2 = Annually,  3 = Weekly,  4 = MultiMonth,  5 = Periodically","required":false,"type":"integer","format":"int32","enum":[0,1,2,3,4,5]},{"name":"sortby","in":"query","description":"Sort By column/field name. (default is Number) 0 = Number,  1 = MoneyIn,  2 = MoneyOut,  3 = Comment,  4 = Project,  5 = Bank","required":false,"type":"integer","format":"int32","enum":[0,1,2,3,4,5]},{"name":"projectnumber","in":"query","description":"Project Number","required":false,"type":"integer","format":"int32"},{"name":"accountid","in":"query","description":"AccountId","required":false,"type":"integer","format":"int32"},{"name":"searchtext","in":"query","description":"Search text","required":false,"type":"string"},{"name":"archived","in":"query","description":"For archived filter","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Paging[KashFlow.Accounting.Model.RecurringBankTransactionListResponse]"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["RecurringBankTransaction"],"summary":"Create recurring bank transaction","operationId":"RecurringBankTransaction_CreateRecurringTransaction","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"recurringBankTransactionRequest","in":"body","description":"recurring bank transaction details","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.RecurringBankTransaction"}}],"responses":{"201":{"description":"Created","schema":{"format":"int32","type":"integer"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"delete":{"tags":["RecurringBankTransaction"],"summary":"Delete multiple recurring bank transaction","operationId":"RecurringBankTransaction_DeleteRecurringBankTransaction","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"recurringTransactionNumber","in":"body","description":"List of bank transactions to be deleted","required":true,"schema":{"type":"array","items":{"format":"int32","type":"integer"}}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"204":{"description":"Deleted recurring bank transaction"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/recurringbanktransaction/archivestatus/{isArchived}":{"put":{"tags":["RecurringBankTransaction"],"summary":"Archive or unarchive multiple recurring bank transaction, by recurring transaction number","operationId":"RecurringBankTransaction_UpdateRecurringTranasactionArchiveStatus","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"isArchived","in":"path","description":"1 for archive and 0 for unarchive","required":true,"type":"boolean"},{"name":"recurringTransactionNumbers","in":"body","description":"list of recurring transaction numbers","required":true,"schema":{"type":"array","items":{"format":"int32","type":"integer"}}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"Archived recurring bank transaction"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/recurringbanktransaction/{number}":{"get":{"tags":["RecurringBankTransaction"],"summary":"Get the details of recurring bank transaction, by number","operationId":"RecurringBankTransaction_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"recurring bank trasnaction number","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringInvoice.RecurringInvoiceResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"put":{"tags":["RecurringBankTransaction"],"summary":"Update recurring bank transaction","operationId":"RecurringBankTransaction_UpdateRecurringTransaction","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"recurring bank transaction number","required":true,"type":"integer","format":"int32"},{"name":"recurringBankTransactionRequest","in":"body","description":"recurring bank transaction details","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.RecurringBankTransaction"}}],"responses":{"201":{"description":"Created","schema":{"format":"int32","type":"integer"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/recurringinvoices":{"get":{"tags":["RecurringInvoice"],"summary":"Get a list of recurring invoices","operationId":"RecurringInvoice_GetPage","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"customercode","in":"query","description":"Customer code","required":false,"type":"string"},{"name":"page","in":"query","description":"Page number. (default is 1)","required":false,"type":"integer","format":"int32"},{"name":"perpage","in":"query","description":"PerPage is number of records per page. (default is 50)","required":false,"type":"integer","format":"int32"},{"name":"order","in":"query","description":"Sorting order (asc or desc) (default is asc)","required":false,"type":"string"},{"name":"filterby","in":"query","description":"Filter data by \"Frequency\" column/field name\r\n            and the avilable values are (All, Monthly, Annually, Weekly, MultiMonth, Periodically) (default is All)","required":false,"type":"string"},{"name":"sortby","in":"query","description":"Sort By column/field name. (default is Number) 0 = Number,  1 = NextDue,  2 = CustomerName,  3 = CustomerReference,  4 = Description,  5 = Expiry,  6 = GrossAmount,  7 = VATAmount,  8 = NetAmount,  9 = Project","required":false,"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,9]},{"name":"projectnumber","in":"query","description":"Project Number","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Paging[KashFlow.Accounting.DTO.RecurringInvoice.RecurringInvoiceListResponse]"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["RecurringInvoice"],"summary":"Create recurring invoice","operationId":"RecurringInvoice_Create","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"recurringInvoiceRequest","in":"body","description":"recurring invoice details","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringInvoice.RecurringInvoiceRequest"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringInvoice.RecurringInvoiceResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/recurringinvoices/{number}":{"get":{"tags":["RecurringInvoice"],"summary":"Get the details of recurring invoices, by ID","operationId":"RecurringInvoice_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"recurring invoice number","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringInvoice.RecurringInvoiceResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"put":{"tags":["RecurringInvoice"],"summary":"Update a recurring invoice, by ID","operationId":"RecurringInvoice_Update","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"recurring invoice number which needs to be updated","required":true,"type":"integer","format":"int32"},{"name":"recurringInvoiceRequest","in":"body","description":"recurring invoice details to be updated","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringInvoice.RecurringInvoiceRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringInvoice.RecurringInvoiceResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access ","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No recurring invoice found with that number"}},"deprecated":false},"delete":{"tags":["RecurringInvoice"],"summary":"Delete a recurring invoice, by ID","operationId":"RecurringInvoice_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"recurring invoice number to be deleted","required":true,"type":"integer","format":"int32"}],"responses":{"204":{"description":"Recurring invoice deleted"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No recurring invoice found with that number"}},"deprecated":false}},"/customers/{code}/recurringinvoices":{"get":{"tags":["RecurringInvoice"],"summary":"Get the list of recurring invoices, by customer code","operationId":"RecurringInvoice_GetRecurringInvoices","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"code","in":"path","description":"Customer code","required":true,"type":"string"},{"name":"page","in":"query","description":"Page number. (default is 1)","required":false,"type":"integer","format":"int32"},{"name":"perpage","in":"query","description":"PerPage is number of records per page. (default is 50)","required":false,"type":"integer","format":"int32"},{"name":"order","in":"query","description":"Sorting order (asc or desc) (default is asc)","required":false,"type":"string"},{"name":"filterby","in":"query","description":"Filter data by \"Frequency\" column/field name\r\n            and the avilable values are (All, Monthly, Annually, Weekly, MultiMonth, Periodically) (default is All)","required":false,"type":"string"},{"name":"sortby","in":"query","description":"Sort By column/field name. (default is Number) 0 = Number,  1 = NextDue,  2 = CustomerName,  3 = CustomerReference,  4 = Description,  5 = Expiry,  6 = GrossAmount,  7 = VATAmount,  8 = NetAmount,  9 = Project","required":false,"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,9]},{"name":"projectnumber","in":"query","description":"Project Number","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Paging[KashFlow.Accounting.DTO.RecurringInvoice.RecurringInvoiceListResponse]"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No customer found with that code"}},"deprecated":false}},"/recurringpurchases":{"get":{"tags":["RecurringPurchase"],"summary":"Get a list of recurring purchases","operationId":"RecurringPurchase_GetPage","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"page","in":"query","description":"Page number. (default is 1)","required":false,"type":"integer","format":"int32"},{"name":"perpage","in":"query","description":"PerPage is number of records per page. (default is 50)","required":false,"type":"integer","format":"int32"},{"name":"order","in":"query","description":"Sorting order (asc or desc)","required":false,"type":"string"},{"name":"filterby","in":"query","description":"Filter By 0 = All,  1 = Monthly,  2 = Annually,  3 = Weekly,  4 = MultiMonth,  5 = Periodically","required":false,"type":"integer","format":"int32","enum":[0,1,2,3,4,5]},{"name":"sortby","in":"query","description":"Sort By column/field name. (default is Number) 0 = Number,  1 = NextDue,  2 = SupplierName,  3 = SupplierReference,  4 = Comment,  5 = Amount,  6 = Expiry,  7 = VatAmount,  8 = NetAmount,  9 = Project","required":false,"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,9]},{"name":"suppliercode","in":"query","description":"Supplier code","required":false,"type":"string"},{"name":"projectnumber","in":"query","description":"Project Number","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Paging[KashFlow.Accounting.DTO.RecurringPurchase.RecurringPurchaseListResponse]"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["RecurringPurchase"],"summary":"Create a recurring purchase","operationId":"RecurringPurchase_Create","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"recurringPurchaseBase","in":"body","description":"recurring purchase details","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringPurchase.RecurringPurchaseRequest"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringPurchase.RecurringPurchaseResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/recurringpurchases/{number}":{"get":{"tags":["RecurringPurchase"],"summary":"Get the recurring purchase details, by ID","operationId":"RecurringPurchase_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"recurring number","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringPurchase.RecurringPurchaseResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"put":{"tags":["RecurringPurchase"],"summary":"Update a recurring purchase, by ID","operationId":"RecurringPurchase_Update","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"recurring purchase number which needs to be updated","required":true,"type":"integer","format":"int32"},{"name":"recurringPurchaseBase","in":"body","description":"recurring purchase details to be updated","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringPurchase.RecurringPurchaseRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringPurchase.RecurringPurchaseResponse"}},"201":{"description":"Recurring Purchase updated with new number","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringPurchase.RecurringPurchaseResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"delete":{"tags":["RecurringPurchase"],"summary":"Delete a recurring purchase by ID","operationId":"RecurringPurchase_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"recurring purchase number to be deleted","required":true,"type":"integer","format":"int32"}],"responses":{"204":{"description":"Recurring purchase deleted"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No recurring purchase found with that number"}},"deprecated":false}},"/suppliers/{code}/recurringpurchases":{"get":{"tags":["RecurringPurchase"],"summary":"Get the recurring purchase list, by customer code","operationId":"RecurringPurchase_GetRecurringPurchases","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"code","in":"path","description":"The supplier code.","required":true,"type":"string"},{"name":"page","in":"query","description":"Page number. (default is 1)","required":false,"type":"integer","format":"int32"},{"name":"perpage","in":"query","description":"PerPage is number of records per page. (default is 50)","required":false,"type":"integer","format":"int32"},{"name":"order","in":"query","description":"Sorting order (asc or desc)","required":false,"type":"string"},{"name":"filterby","in":"query","description":"Filter By 0 = All,  1 = Monthly,  2 = Annually,  3 = Weekly,  4 = MultiMonth,  5 = Periodically","required":false,"type":"integer","format":"int32","enum":[0,1,2,3,4,5]},{"name":"sortby","in":"query","description":"Sort By column/field name. (default is Number) 0 = Number,  1 = NextDue,  2 = SupplierName,  3 = SupplierReference,  4 = Comment,  5 = Amount,  6 = Expiry,  7 = VatAmount,  8 = NetAmount,  9 = Project","required":false,"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,9]},{"name":"suppliercode","in":"query","description":"Supplier code","required":false,"type":"string"},{"name":"projectnumber","in":"query","description":"Project Number","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Paging[KashFlow.Accounting.DTO.RecurringPurchase.RecurringPurchaseListResponse]"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No supplier found with the provided code"}},"deprecated":false}},"/referral/code":{"post":{"tags":["Referral"],"summary":"Create a referral code","operationId":"Referral_CreateReferralCode","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/internal/invoices/refund/baddebt":{"post":{"tags":["Refund"],"summary":"Create a bad debt record for an invoice","operationId":"Refund_ApplyRefund","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"refund","in":"body","description":"Refund","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Refund"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Not Found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/reminderletters":{"get":{"tags":["ReminderLetter"],"summary":"Get list of reminder letters","operationId":"ReminderLetter_GetList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.ReminderLetter.ReminderLetterBase"}}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/defaults/reminderletters/{number}":{"get":{"tags":["ReminderLetter"],"summary":"Get reminder letter details, by number","operationId":"ReminderLetter_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"ReminderLetter Number","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.ReminderLetter.ReminderLetterBase"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No ReminderLetter found with that number"}},"deprecated":false}},"/invoices/{invoicenumber}/reminderletters":{"post":{"tags":["ReminderLetter"],"summary":"Create a reminder letter","operationId":"ReminderLetter_Create","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"invoicenumber","in":"path","description":"invoicenumber","required":true,"type":"integer","format":"int32"},{"name":"reminderLetterBase","in":"body","description":"reminderLetter Details","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.ReminderLetter.ReminderLetterBase"}}],"responses":{"201":{"description":"Created","schema":{"type":"string"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/reminderletters/{number}":{"put":{"tags":["ReminderLetter"],"summary":"Update a reminder letter","operationId":"ReminderLetter_Update","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"reminderLette Number","required":true,"type":"integer","format":"int32"},{"name":"reminderLetterBase","in":"body","description":"reminderLetter Details","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.ReminderLetter.ReminderLetterBase"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.ReminderLetter.ReminderLetterBase"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/invoices/{invoicenumber}/reminderletters/{reminderletternumber}":{"put":{"tags":["ReminderLetter"],"summary":"Mark a reminder letter as sent","operationId":"ReminderLetter_MarkReminderLetterAsSent","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"invoicenumber","in":"path","description":"invoicenumber","required":true,"type":"integer","format":"int32"},{"name":"reminderletternumber","in":"path","description":"reminderletternumber","required":true,"type":"integer","format":"int32"},{"name":"reminderLetterRequest","in":"body","description":"reminderLetterRequest","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.ReminderLetter.ReminderLetterRequest"}}],"responses":{"200":{"description":"Marked reminder letter as sent"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/reports":{"get":{"tags":["Report"],"summary":"Get a list of reports","operationId":"Report_GetAll","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/reports/{reportId}":{"put":{"tags":["Report"],"summary":"Update the report details","operationId":"Report_Put","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"reportId","in":"path","description":"Report Id","required":true,"type":"integer","format":"int32"},{"name":"report","in":"body","description":"Report","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.ReportsListItem"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/reportcache":{"delete":{"tags":["ReportCache"],"summary":"Delete all reports","operationId":"ReportCache_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"entityType","in":"query","description":"Entity Type","required":true,"type":"integer","format":"int32"},{"name":"previousDate","in":"query","description":"Previous Date","required":false,"type":"string","format":"date-time"},{"name":"newDate","in":"query","description":"New Date","required":false,"type":"string","format":"date-time"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/reports/coversheet":{"get":{"tags":["ReportCoverSheet"],"summary":"Get the client and partner details for the cover sheet","operationId":"ReportCoverSheet_GetCoverSheet","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/reports/settings":{"get":{"tags":["ReportsSettings"],"summary":"Get the report UI settings","operationId":"ReportsSettings_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.Settings.ReportsSettings"}},"404":{"description":"Not Found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"put":{"tags":["ReportsSettings"],"summary":"Set the report UI settings","operationId":"ReportsSettings_Put","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"reportsSettings","in":"body","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.Settings.ReportsSettings"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.Settings.ReportsSettings"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/roles":{"get":{"tags":["Role"],"summary":"Get a list of roles","operationId":"Role_GetList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Response.RoleResponse"}}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/salesagent/createcustomer":{"post":{"tags":["SalesAgent"],"operationId":"SalesAgent_CreateCustomer","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"salesAgentSale","in":"body","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.SalesAgent.SalesAgentSale"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/salesagent/chargecard":{"post":{"tags":["SalesAgent"],"operationId":"SalesAgent_ChargeCard","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"salesAgentSale","in":"body","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.SalesAgent.SalesAgentSale"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/salesagent/createinvoice":{"post":{"tags":["SalesAgent"],"operationId":"SalesAgent_CreateInvoice","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"salesAgentSale","in":"body","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.SalesAgent.SalesAgentSale"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/salesagent/emailinvoice":{"post":{"tags":["SalesAgent"],"operationId":"SalesAgent_EmailInvoice","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"salesAgentSale","in":"body","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.SalesAgent.SalesAgentSale"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/salesagent/migratepartner":{"post":{"tags":["SalesAgent"],"summary":"Migrate the partner details to PayAdmin","operationId":"SalesAgent_MigratePartner","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"salesAgentSale","in":"body","description":"the partner details to be migrated to be PayAdmin","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.SalesAgent.SalesAgentSale"}}],"responses":{"200":{"description":"Partner migrated successfully to PayAdmin.","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.SalesAgent.SalesAgentResponse"}},"400":{"description":"There is some problem with migrating partner details to PayAmdin.","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.SalesAgent.SalesAgentResponse"}}},"deprecated":false}},"/salesagent/emailcreditbalance":{"post":{"tags":["SalesAgent"],"operationId":"SalesAgent_EmailCreditBalance","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"salesAgentSale","in":"body","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.SalesAgent.SalesAgentSale"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/salesagent/customerexists":{"post":{"tags":["SalesAgent"],"operationId":"SalesAgent_CustomerExists","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"customercode","in":"query","required":true,"type":"string"},{"name":"kashflowcustomerId","in":"query","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/reports/sales/unallocated-customer-payment":{"get":{"tags":["SalesReport"],"summary":"Get the Unallocated Customer Payments Report","operationId":"SalesReport_GetUnallocatedCustomerPaymentReport","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"customercode","in":"query","required":false,"type":"string"},{"name":"startdate","in":"query","required":true,"type":"string"},{"name":"enddate","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.UnallocatedCustomerPaymentReports"}}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/reports/sales/unpaid-invoices":{"get":{"tags":["SalesReport"],"summary":"Get unpaid invoice report","operationId":"SalesReport_GetUnpaidInvoiceReport","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"orderBy","in":"query","description":"Sorting order (asc or desc) (default is desc)","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.SalesReport.SalesInvoiceResponse"}}},"deprecated":false}},"/reports/sales/sales-code-by-month":{"get":{"tags":["SalesReport"],"summary":"Get Sales Codes by Month Report","operationId":"SalesReport_GetSalesCodeByMonth","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"startdate","in":"query","required":false,"type":"string"},{"name":"enddate","in":"query","required":false,"type":"string"},{"name":"code","in":"query","required":false,"type":"integer","format":"int32"},{"name":"show","in":"query","description":" 0 = MoneyMode,  1 = UnitsSold","required":false,"type":"integer","format":"int32","enum":[0,1]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.SalesReport.SalesCodeByMonthReport.SalesCodeByMonthResponse"}}},"deprecated":false}},"/reports/sales/income":{"get":{"tags":["SalesReport"],"summary":"Get sales income report","operationId":"SalesReport_GetSalesIncomeReport","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"incomeby","in":"query","description":" 0 = PaymentMethod,  1 = Customer,  2 = Source,  3 = Product,  4 = SalesType,  5 = All","required":false,"type":"integer","format":"int32","enum":[0,1,2,3,4,5]},{"name":"startdate","in":"query","required":false,"type":"string"},{"name":"enddate","in":"query","required":false,"type":"string"},{"name":"basedon","in":"query","description":" 0 = Issued,  1 = Paid","required":false,"type":"integer","format":"int32","enum":[0,1]},{"name":"sourceid","in":"query","required":false,"type":"integer","format":"int32"},{"name":"projectid","in":"query","required":false,"type":"integer","format":"int32"},{"name":"includebankpayments","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.Sales.SaleIncome.SalesIncomeResponse"}}},"deprecated":false}},"/reports/sales/sales-history":{"get":{"tags":["SalesReport"],"summary":"Get sales history report","operationId":"SalesReport_GetSalesHistoryReport","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"startdate","in":"query","required":true,"type":"string"},{"name":"enddate","in":"query","required":true,"type":"string"},{"name":"nominalcode","in":"query","required":true,"type":"integer","format":"int32"},{"name":"productcode","in":"query","required":false,"type":"string"},{"name":"includecustomercontactdetails","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.Sales.SalesHistory.SalesHistoryResponse"}}}},"deprecated":false}},"/reports/sales/overdue-invoices":{"get":{"tags":["SalesReport"],"summary":"Get overdue invoice report","operationId":"SalesReport_GetOverdueInvoiceReport","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"orderBy","in":"query","description":"Sorting order (asc or desc) (default is desc)","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.SalesReport.SalesInvoiceResponse"}}},"deprecated":false}},"/reports/sales/monthly":{"get":{"tags":["SalesReport"],"summary":"Get monthly sales report","operationId":"SalesReport_GetMonthlySalesData","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"startdate","in":"query","required":false,"type":"string"},{"name":"enddate","in":"query","required":false,"type":"string"},{"name":"includebankpayments","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.Sales.MonthlySales.MonthlySalesResponse"}}}},"deprecated":false}},"/reports/sales/customer-purchase-history":{"get":{"tags":["SalesReport"],"summary":"Get customer purchase history report","operationId":"SalesReport_GetCustomerPurchaseHistoryReport","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"startdate","in":"query","required":true,"type":"string"},{"name":"enddate","in":"query","required":true,"type":"string"},{"name":"customercode","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.Sales.CustomerPurchaseHistory.CustomerPurchaseHistoryResponse"}}}},"deprecated":false}},"/reports/sales/customer-report":{"get":{"tags":["SalesReport"],"summary":"Get customer report","operationId":"SalesReport_GetCustomerReport","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"customer","in":"query","description":" 0 = AllCustomers,  1 = CustomersInvoicedBetweenDates","required":false,"type":"integer","format":"int32","enum":[0,1]},{"name":"startdate","in":"query","required":false,"type":"string"},{"name":"enddate","in":"query","required":false,"type":"string"},{"name":"includearchivedcustomers","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.SalesReport.CustomerReport.CustomerReportResponse"}}},"deprecated":false}},"/reports/sales/income-report-by-product-csv":{"get":{"tags":["SalesReport"],"summary":"Get income report by product download csv","operationId":"SalesReport_GetIncomeReportByProductCSV","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"startdate","in":"query","required":false,"type":"string"},{"name":"enddate","in":"query","required":false,"type":"string"},{"name":"basedon","in":"query","description":" 0 = Issued,  1 = Paid","required":false,"type":"integer","format":"int32","enum":[0,1]},{"name":"sourceid","in":"query","required":false,"type":"integer","format":"int32"},{"name":"projectid","in":"query","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.SalesReport.IncomeReportByProductCSV.IncomeReportByProductCsvResponse"}}}},"deprecated":false}},"/reports/sales/income-report-by-salescode-csv":{"get":{"tags":["SalesReport"],"summary":"Get income report by sales code download csv","operationId":"SalesReport_GetIncomeReportBySalesCodeCSV","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"startdate","in":"query","required":false,"type":"string"},{"name":"enddate","in":"query","required":false,"type":"string"},{"name":"basedon","in":"query","description":" 0 = Issued,  1 = Paid","required":false,"type":"integer","format":"int32","enum":[0,1]},{"name":"sourceid","in":"query","required":false,"type":"integer","format":"int32"},{"name":"projectid","in":"query","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.SalesReport.IncomeReport.IncomeReportByResponseBase"}}}},"deprecated":false}},"/reports/sales/income-report-by-paymentmethod-csv":{"get":{"tags":["SalesReport"],"summary":"Get income report by method download csv","operationId":"SalesReport_GetIncomeReportByMethodCSV","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"startDate","in":"query","description":"Start date","required":true,"type":"string"},{"name":"endDate","in":"query","description":"End date","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.SalesReport.SaleIncomeReports.SalesIncomeCsvResponse"}}}},"deprecated":false}},"/reports/sales/income-report-by-source-csv":{"get":{"tags":["SalesReport"],"summary":"Get income report by souce csv","operationId":"SalesReport_GetIncomeReportBySourceCSV","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"startDate","in":"query","description":"Start date","required":true,"type":"string"},{"name":"endDate","in":"query","description":"End date","required":true,"type":"string"},{"name":"isPaid","in":"query","description":"Is paid","required":true,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.SalesReport.SaleIncomeReports.SalesIncomeCsvResponse"}}}},"deprecated":false}},"/search":{"get":{"tags":["Search"],"summary":"Gets the search results based on the provided search text and filters.","operationId":"Search_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"searchtext","in":"query","required":true,"type":"string"},{"name":"searchentitytype","in":"query","required":true,"type":"string"},{"name":"exactmatch","in":"query","required":false,"type":"boolean"},{"name":"startdate","in":"query","required":false,"type":"integer","format":"int64","maximum":99991231,"minimum":10000101},{"name":"enddate","in":"query","required":false,"type":"integer","format":"int64","maximum":99991231,"minimum":10000101},{"name":"pagenumber","in":"query","required":false,"type":"integer","format":"int32"},{"name":"perpage","in":"query","required":false,"type":"integer","format":"int32"},{"name":"sortorder","in":"query","description":" 0 = Asc,  1 = Desc","required":false,"type":"integer","format":"int32","enum":[0,1]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.GlobalSearch.GlobalSearchResult"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/tax/selfassessment":{"get":{"tags":["SelfAssessmentTax"],"summary":"Get a non persisted self assessment for an accounting period.","operationId":"SelfAssessmentTax_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"startDate","in":"query","description":"Accounting period start date","required":true,"type":"string","format":"date-time"},{"name":"endDate","in":"query","description":"Accounting period end date","required":true,"type":"string","format":"date-time"},{"name":"accountingType","in":"query","description":"Accounting type 0 = Cash,  1 = Accrual","required":false,"type":"integer","format":"int32","enum":[0,1]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/sendgridwebhook":{"post":{"tags":["SendGridWebhook"],"summary":"Update sendgrid mail status from webhook","operationId":"SendGridWebhook_Post","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/settings":{"get":{"tags":["Settings"],"summary":"Get the account settings","operationId":"Settings_GetAll","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/settings/single":{"get":{"tags":["Settings"],"summary":"Get a specific account setting for the selected user","operationId":"Settings_GetSingle","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"key","in":"query","description":"setting name","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/settings/advanced":{"get":{"tags":["Settings"],"summary":"Get the advanced account settings for the selected user","operationId":"Settings_GetAdvanceSettings","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/settings/invoice":{"get":{"tags":["Settings"],"summary":"Get the invoice settings for the  account","operationId":"Settings_GetInvoice","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/settings/menu":{"get":{"tags":["Settings"],"summary":"Get the main menu settings","operationId":"Settings_GetMenuSettings","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/settings/project":{"get":{"tags":["Settings"],"summary":"Get the project settings","operationId":"Settings_GetProjectSettings","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false},"put":{"tags":["Settings"],"summary":"Update project settings","operationId":"Settings_UpdateProjectSettings","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"projectSettings","in":"body","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Settings.ProjectSettingsRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Settings.ProjectSettings"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/settings/quote":{"get":{"tags":["Settings"],"summary":"Get the quote settings","operationId":"Settings_GetQuoteSettings","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/settings/user":{"get":{"tags":["Settings"],"summary":"Get the account settings for the selected user","operationId":"Settings_GetUserSettings","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/settings/referral":{"get":{"tags":["Settings"],"summary":"Get the referral settings","operationId":"Settings_GetReferralSettings","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/settings/api":{"get":{"tags":["Settings"],"summary":"Get the API settings","operationId":"Settings_GetApiSettings","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false},"put":{"tags":["Settings"],"summary":"Update the API settings","operationId":"Settings_UpdateAPISettings","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"apiSettings","in":"body","description":"API settings","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Settings.APISettings"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/settings/api-autoauthkey":{"put":{"tags":["Settings"],"summary":"Reset and return the API AutoAuthKey","operationId":"Settings_ResetAndGetApiAutoAuthKey","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/settings/termsandconditions":{"get":{"tags":["Settings"],"summary":"Get the setting that determines whether the Terms &amp; Conditions are displayed","operationId":"Settings_GetTermsAndConditionsStatus","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false},"post":{"tags":["Settings"],"summary":"Accept the Terms &amp; Conditions","operationId":"Settings_AcceptTermsAndConditions","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/settings/docfire":{"post":{"tags":["Settings"],"summary":"Disable the docfire dialog box","operationId":"Settings_DisableDocFireDialog","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/settings/gocardless":{"get":{"tags":["Settings"],"summary":"Get the payment processor settings for GoCardless","operationId":"Settings_GetGoCardlessSettings","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Settings.GoCardlessSettings"}}},"deprecated":false},"put":{"tags":["Settings"],"summary":"Update the GoCardless settings","operationId":"Settings_UpdateGoCardlessSettings","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"goCardlessSettings","in":"body","description":"GoCardless setting","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Settings.GoCardlessSettings"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/settings/mileage":{"get":{"tags":["Settings"],"summary":"Get the mileage settings","operationId":"Settings_GetMileageSettings","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Settings.MileageSettings"}}},"deprecated":false},"put":{"tags":["Settings"],"summary":"Update the mileage settings","operationId":"Settings_UpdateMileageSettings","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"mileageSettings","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Settings.MileageSettings"}},{"name":"action","in":"query","description":"","required":false,"type":"string"}],"responses":{"200":{"description":"Your Mileages Settings updated successfully","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Settings.MileageSettings"}},"400":{"description":"Thrown on violation of business rules","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Thrown if entity doesn't exist"}},"deprecated":false},"post":{"tags":["Settings"],"summary":"Save the mileage settings","operationId":"Settings_SaveMileageSettings","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"mileageSettings","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Settings.MileageSettings"}}],"responses":{"201":{"description":"Mileage Settings saved successfully","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Settings.MileageSettings"}}},"deprecated":false}},"/settings/pdfthemes":{"get":{"tags":["Settings"],"summary":"Get a list of PDF themes","operationId":"Settings_GetPdfThemes","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/settings/profile":{"get":{"tags":["Settings"],"summary":"Get user profile details","operationId":"Settings_GetUserProfile","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Settings.UserProfile"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"put":{"tags":["Settings"],"summary":"Update user profile details","operationId":"Settings_UpdateUserProfile","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"profileUpdateRequest","in":"body","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Settings.ProfileUpdateRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Settings.UserProfile"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/oauthsigneduri":{"get":{"tags":["SignedUri"],"summary":"Generate the signed url for authentication","operationId":"SignedUri_GetSignedUrl","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"url","in":"query","description":"Encoded url for signing","required":true,"type":"string"},{"name":"endpoint","in":"query","description":"Endpoint e.g. DropBox,TRADESHIFT","required":true,"type":"string"},{"name":"method","in":"query","description":"HTTP Method","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/signups":{"get":{"tags":["Signup"],"summary":"Check the validity of the  activation link","operationId":"Signup_GetActivationLinkDetails","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"activationLinkGUID","in":"query","description":"activation link GUID from uri","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Signup.ActivationLinkDetails"}},"400":{"description":"activationLinkDetails","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Signup.ActivationLinkDetailedResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"put":{"tags":["Signup"],"summary":"Expire the existing activation link, create a new activation link, and send via email to the user","operationId":"Signup_RegenerateActivationLinkGuid","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"signupRequest","in":"body","description":"resendactivationlink guid from signup model","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Signup.SignupRequest"}}],"responses":{"200":{"description":"Updated Signup for user"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["Signup"],"summary":"Create the user account","operationId":"Signup_CreateSignup","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"signupRequest","in":"body","description":"Signup Details","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Signup.SignupUserBase"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Signup.SignupResponse"}},"201":{"description":"Created","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Signup.SignupResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/signups/credentials":{"post":{"tags":["Signup"],"summary":"Create the user account with valid credentials","operationId":"Signup_CreateUserAccount","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"signupCredentialRequest","in":"body","description":"SignupCredential Details","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Signup.SignupCredentialsRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"201":{"description":"Created UserAccount"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/signups/activationlink":{"get":{"tags":["Signup"],"summary":"Get the activation link","operationId":"Signup_GetActivationLink","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"resendActivationLinkGuid","in":"query","description":"ResendActivationLinkGuid","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/signups/iris-user":{"post":{"tags":["Signup"],"summary":"Create the user account","operationId":"Signup_CreateIrisSignup","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"signupRequest","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Signup.IrisUserSignupRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"201":{"description":"User created successfully."},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Signup.IrisUserSignupResponse"}}},"deprecated":false}},"/SMTPConfig":{"get":{"tags":["SMTPConfig"],"summary":"Get the user’s SMTP configuration","operationId":"SMTPConfig_GetSMTPConfig","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.SMTPConfigResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No SMTP Configuration found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"put":{"tags":["SMTPConfig"],"summary":"Update the user’s SMTP configuration","operationId":"SMTPConfig_UpdateSMTPConfig","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"smtpConfig","in":"body","description":"smtp details to be updated","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.SMTPConfigRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.SMTPConfigResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No SMTP Configuration found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"delete":{"tags":["SMTPConfig"],"summary":"Delete the user’s SMTP configuration","operationId":"SMTPConfig_DeleteSMTPConfig","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"Deleted SMTP Configuration"},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No SMTP Configuration found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/SMTPOAuth/authurl":{"get":{"tags":["SMTPOAuth"],"summary":"Get the authorization URL for Outlook OAuth","operationId":"SMTPOAuth_GetAuthorizationUrl","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"referralUrl","in":"query","description":"referral Url","required":true,"type":"string"},{"name":"oauthconfig.clientid","in":"query","required":false,"type":"string"},{"name":"oauthconfig.secretid","in":"query","required":false,"type":"string"},{"name":"oauthconfig.tenantid","in":"query","required":false,"type":"string"},{"name":"fromname","in":"query","required":false,"type":"string"},{"name":"fromemail","in":"query","required":false,"type":"string"},{"name":"overridesmtpconfig","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"Returns outlook oauth authorization url"},"404":{"description":"Referral url cannot be empty","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/SMTPOAuth/accesstoken":{"get":{"tags":["SMTPOAuth"],"summary":"Called by Outlook once authorization is successful","operationId":"SMTPOAuth_GetAcessToken","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"state","in":"query","description":"The value of the state parameter you provided in the authorisation request, whether or not authorisation is successful.","required":true,"type":"string"},{"name":"code","in":"query","description":"The authorisation code, if authorisation is successful","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/SMTPOAuth/disconnect":{"delete":{"tags":["SMTPOAuth"],"summary":"Delete the OAuth access token","operationId":"SMTPOAuth_Disconnect","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"NoContent"}},"deprecated":false}},"/integrations/square/locations":{"get":{"tags":["SquareIntegration"],"summary":"Gets the merchant locations.","operationId":"SquareIntegration_GetMerchantLocations","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"isPayOnline","in":"query","description":"if set to true [is pay online].","required":false,"type":"boolean"}],"responses":{"200":{"description":"The Merchant locations","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Payment.Square.Location"}}},"400":{"description":"The provided payment processor authorization information is not valid"},"404":{"description":"No payment processor found, or the payment processor is deprecated"}},"deprecated":false}},"/integrations/square/accounts":{"get":{"tags":["SquareIntegration"],"summary":"Gets the accounts.","operationId":"SquareIntegration_GetAccountsAsync","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"The user's square import accounts","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.InvoiceImporter.ImportProfile"}}}},"deprecated":false}},"/integrations/square/accounts/visibility":{"get":{"tags":["SquareIntegration"],"summary":"Gets the square page accounts visibility","operationId":"SquareIntegration_GetSquareAccountsVisibility","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"True if the accounts are visible for the square page","schema":{"type":"boolean"}}},"deprecated":false},"put":{"tags":["SquareIntegration"],"summary":"Shows or hides the square accounts visibility.","operationId":"SquareIntegration_ShowHideSquareAccounts","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"isVisible","in":"query","description":"if set to true [is visible].","required":true,"type":"boolean"}],"responses":{"204":{"description":"The visibility for square's page accounts was set"}},"deprecated":false}},"/integrations/square/wizard/status":{"get":{"tags":["SquareIntegration"],"summary":"Gets the Setup Wizard enabled/disabled status","operationId":"SquareIntegration_GetSetupWizardStatus","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"True if the setup wizard hasn't been skipped or no account has ever been configured","schema":{"type":"boolean"}}},"deprecated":false},"put":{"tags":["SquareIntegration"],"summary":"Gets the Setup Wizard enabled/disabled status","operationId":"SquareIntegration_SetSetupWizardStatus","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"isEnabled","in":"query","description":"if set to true [is enabled].","required":true,"type":"boolean"}],"responses":{"204":{"description":"The visibility for square's setup wizard was set"}},"deprecated":false}},"/integrations/square/wizard/steps/customer/status":{"get":{"tags":["SquareIntegration"],"summary":"Gets the Setup Wizard Customer Step (2) status","operationId":"SquareIntegration_GetSquareWizardCustomerStepStatus","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"True if the setup wizard customer step has been completed before","schema":{"type":"boolean"}}},"deprecated":false},"post":{"tags":["SquareIntegration"],"summary":"Sets the Setup Wizard Customer Step (2) as done.","operationId":"SquareIntegration_SetSquareWizardCustomerStepStatus","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"204":{"description":"The setup wizard customer step has been marked as completed"}},"deprecated":false}},"/integrations/square/accounts/{accountId}/locations":{"get":{"tags":["SquareIntegration"],"summary":"Gets the Square Account locations available","operationId":"SquareIntegration_GetAccountLocations","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"The user's square import accounts","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Payment.Square.Location"}}}},"deprecated":false}},"/integrations/square/accounts/{accountId}":{"put":{"tags":["SquareIntegration"],"summary":"Updates the Square Account","operationId":"SquareIntegration_UpdateAccount","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"account","in":"body","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.InvoiceImporter.ImportProfile"}}],"responses":{"200":{"description":"The account was updated successfully","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.InvoiceImporter.ImportProfile"}},"400":{"description":"The account Id provided is not valid","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.InvoiceImporter.ImportProfile"}}},"deprecated":false},"delete":{"tags":["SquareIntegration"],"summary":"Deletes the square account","operationId":"SquareIntegration_DeleteSquareAccount","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"204":{"description":"The square account was deleted","schema":{"type":"boolean"}},"400":{"description":"The square could not be deleted","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/integrations/square/accounts/{accountId}/settings":{"get":{"tags":["SquareIntegration"],"summary":"Gets the Square Account importer settings","operationId":"SquareIntegration_GetAccountSettings","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"The account settings","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.InvoiceImporter.ImportSettings"}},"400":{"description":"The account Id provided is not valid"}},"deprecated":false},"put":{"tags":["SquareIntegration"],"summary":"Updates the Square Account importer settings","operationId":"SquareIntegration_UpdateAccountSettings","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"importSettings","in":"body","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.InvoiceImporter.ImportSettings"}}],"responses":{"200":{"description":"The account settings were updated successfully","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.InvoiceImporter.ImportSettings"}},"400":{"description":"The account Id provided is not valid"}},"deprecated":false}},"/integrations/square/accounts/{accountId}/runs":{"get":{"tags":["SquareIntegration"],"summary":"Gets the Square Account import activity","operationId":"SquareIntegration_GetAccountActivity","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"Account Id","required":true,"type":"integer","format":"int32"},{"name":"filter","in":"query","description":"Filter (All, Pending, etc) 0 = All,  1 = Pending,  2 = WithInvoices,  3 = WithoutInvoices","required":false,"type":"integer","format":"int32","enum":[0,1,2,3]},{"name":"page","in":"query","description":"Page number","required":false,"type":"integer","format":"int32"},{"name":"perpage","in":"query","description":"Items per page","required":false,"type":"integer","format":"int32"},{"name":"order","in":"query","description":"Sort order (asc|desc) 0 = Asc,  1 = Desc","required":false,"type":"integer","format":"int32","enum":[0,1]},{"name":"sortBy","in":"query","description":"Column to sort by 0 = EndDate,  1 = StartDate,  2 = Status,  3 = NumberOfPayments,  4 = NumberOfRefunds,  5 = InvoiceNumber,  6 = ExecutionDate,  7 = TimezoneName,  8 = ProfileId","required":false,"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8]}],"responses":{"200":{"description":"The account import runs","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Paging[KashFlow.Accounting.Model.InvoiceImporter.ImportRun]"}},"400":{"description":"The account Id provided is not valid"}},"deprecated":false}},"/integrations/square/oauthauthorizeurl":{"get":{"tags":["SquareIntegration"],"summary":"Gets the square oauth authorize URL","operationId":"SquareIntegration_GetSquareAuthorizeUrl","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"importer","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}},"deprecated":false}},"/integrations/square/authorize":{"get":{"tags":["SquareIntegration"],"summary":"Gets the square oauth direct URL","operationId":"SquareIntegration_Authorize","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"code","in":"query","required":false,"type":"string"},{"name":"redirect_uri","in":"query","required":false,"type":"string"},{"name":"state","in":"query","required":false,"type":"string"},{"name":"refresh_token","in":"query","required":false,"type":"string"},{"name":"error","in":"query","required":false,"type":"string"},{"name":"error_description","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"400":{"description":"BadRequest","schema":{"type":"string"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/integrations/square/nextSync":{"get":{"tags":["SquareIntegration"],"summary":"Gets the date of the next synchronization.\r\n            (This output is cached for 5 minutes)","operationId":"SquareIntegration_GetNextSync","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"format":"date-time","type":"string"}}},"deprecated":false}},"/integrations/square/customer/export/{accountId}":{"get":{"tags":["SquareIntegration"],"summary":"Gets all customers to export","operationId":"SquareIntegration_GetCustomersToExport","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"","required":true,"type":"integer","format":"int32"},{"name":"fieldsSearch","in":"query","description":"","required":false,"type":"string"},{"name":"order","in":"query","description":"Sort order (asc|desc) 0 = Asc,  1 = Desc","required":false,"type":"integer","format":"int32","enum":[0,1]}],"responses":{"200":{"description":"The customers to export","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.CustomerSquareSync"}}},"400":{"description":"The account Id provided is not valid"}},"deprecated":false},"post":{"tags":["SquareIntegration"],"summary":"Send Kashflow customers to Square","operationId":"SquareIntegration_SendCustomersToSquare","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"","required":true,"type":"integer","format":"int32"},{"name":"customersSync","in":"body","description":"","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.CustomerSync"}}}],"responses":{"204":{"description":"Customers exported","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.CustomerSquareSync"}}},"400":{"description":"The account Id provided is not valid"}},"deprecated":false}},"/integrations/square/customer/import/{accountId}":{"get":{"tags":["SquareIntegration"],"summary":"Gets all customers to import","operationId":"SquareIntegration_GetCustomersToImport","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"","required":true,"type":"integer","format":"int32"},{"name":"fieldsSearch","in":"query","description":"","required":false,"type":"string"},{"name":"order","in":"query","description":"Sort order (asc|desc) 0 = Asc,  1 = Desc","required":false,"type":"integer","format":"int32","enum":[0,1]}],"responses":{"200":{"description":"The customers to import","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.CustomerSquareSync"}}},"400":{"description":"The account Id provided is not valid"}},"deprecated":false},"post":{"tags":["SquareIntegration"],"summary":"Import Square customers to KashFlow","operationId":"SquareIntegration_ImportCustomersToKashflow","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","description":"","required":true,"type":"integer","format":"int32"},{"name":"customersSync","in":"body","description":"","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.CustomerSync"}}}],"responses":{"204":{"description":"Customers imported","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.CustomerSquareSync"}}},"400":{"description":"The account Id provided is not valid"}},"deprecated":false}},"/integrations/square/accounts/{accountId}/settlements":{"get":{"tags":["SquareIntegration"],"summary":"Gets the Square Account import activity","operationId":"SquareIntegration_GetSettlements","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"page","in":"query","required":false,"type":"integer","format":"int32"},{"name":"perpage","in":"query","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"The account import runs","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.InvoiceImporter.ImportSettlement"}}},"400":{"description":"The account Id provided is not valid"}},"deprecated":false}},"/integrations/square/account/new":{"get":{"tags":["SquareIntegration"],"summary":"New square account redirection URL","operationId":"SquareIntegration_GetRedirectUrl","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"code","in":"query","description":"","required":true,"type":"string"},{"name":"response_type","in":"query","description":"","required":true,"type":"string"},{"name":"state","in":"query","description":"","required":true,"type":"string"}],"responses":{},"deprecated":false}},"/stockoptions":{"get":{"tags":["StockOptions"],"summary":"Get the data for stock options","operationId":"StockOptions_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.StockOptions"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"put":{"tags":["StockOptions"],"summary":"Update the data for stock options","operationId":"StockOptions_Put","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"stockOptions","in":"body","description":"Update stock options data","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.StockOptions"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.StockOptions"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/subscription/cancellationreasons":{"get":{"tags":["Subscription"],"summary":"Get the list of subscription cancellation reasons","operationId":"Subscription_GetCancellationReasons","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/subscription/packages":{"get":{"tags":["Subscription"],"summary":"Get the list of subscription packages","operationId":"Subscription_GetAllPackages","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.UserSubscription.Package"}}}},"deprecated":false}},"/subscription/packages/ios":{"get":{"tags":["Subscription"],"summary":"Get the list of subscription packages available for iOS","operationId":"Subscription_GetIOSPackages","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"applicationType","in":"query","description":" 1 = RsrApp,  2 = OldWebApp,  3 = MobileIOS,  4 = MobileAndroid,  5 = KFConnect,  6 = IrisElementBookkeepingIOS,  7 = IrisElementBookkeepingAndroid","required":false,"type":"integer","format":"int32","enum":[1,2,3,4,5,6,7]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.UserSubscription.Package"}}}},"deprecated":false}},"/subscription":{"get":{"tags":["Subscription"],"summary":"Get the subscription details of the user","operationId":"Subscription_GetSubscriptionInfo","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false},"put":{"tags":["Subscription"],"summary":"Update the user subscription","operationId":"Subscription_Update","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"subscriptionInfo","in":"body","description":"Subscription Info","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.UserSubscription.SubscriptionInfo"}},{"name":"action","in":"query","description":"Action","required":false,"type":"string"},{"name":"instantCollection","in":"query","description":"When starting subscription whether to take collection immediately","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false},"delete":{"tags":["Subscription"],"summary":"Cancel the subscription","operationId":"Subscription_DeleteSubscription","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"cancelSubscription","in":"body","description":"Cancel Subscription parameter","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.UserSubscription.CancelSubscription"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/subscription/forward":{"put":{"tags":["Subscription"],"summary":"Update the subscription expiry date","operationId":"Subscription_FastForward","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"days","in":"query","description":"Days","required":true,"type":"integer","format":"int32"},{"name":"expireUser","in":"query","description":"Expire User","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/subscription/chargedDetails":{"get":{"tags":["Subscription"],"summary":"Get the charged details for the  package ID","operationId":"Subscription_GetSubscriptionPaymentDetails","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"packageId","in":"query","description":"Package Id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/subscription/cancel/reasons":{"get":{"tags":["Subscription"],"summary":"Get cancellation reason subcategories","operationId":"Subscription_GetCancelReasons","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"parentId","in":"query","description":"Parent Id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.UserSubscription.CancelReasons"}}}},"deprecated":false}},"/subscription/cancel/competitors":{"get":{"tags":["Subscription"],"summary":"Get the list of competitors","operationId":"Subscription_GetSimilarProducts","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.UserSubscription.CompetetiveProduct"}}}},"deprecated":false}},"/suppliers/{code}/statistics":{"get":{"tags":["Supplier"],"summary":"Get the supplier transaction statistics, by code","operationId":"Supplier_GetStatistics","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"code","in":"path","description":"Supplier Code","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.SupplierStatistics"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No supplier found with that code"}},"deprecated":false},"put":{"tags":["Supplier"],"summary":"Refresh the transaction statistics for a supplier, by code","operationId":"Supplier_UpdateStatistics","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"code","in":"path","description":"Supplier code","required":true,"type":"string"}],"responses":{"200":{"description":"Supplier statistisc updated"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No supplier found with that code"}},"deprecated":false}},"/suppliers/statistics":{"get":{"tags":["Supplier"],"summary":"Get all supplier transaction statistics","operationId":"Supplier_GetSuppliersStatistics","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.SuppliersStatistics"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No supplier found"}},"deprecated":false},"put":{"tags":["Supplier"],"summary":"Refresh the transaction statistics for all suppliers","operationId":"Supplier_UpdateStatistics","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"Supplier statistisc updated"},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No supplier found with that code"}},"deprecated":false}},"/suppliers/statistics/transactions/visibility":{"get":{"tags":["Supplier"],"summary":"Get the visibility status of transaction statistics on the Supplier Details page","operationId":"Supplier_GetSupplierStatisticsVisibility","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"True is the statistics are visible for the supplier transaction page","schema":{"type":"boolean"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"put":{"tags":["Supplier"],"summary":"Toggle the visibility of the transaction statistics on the Supplier Details page","operationId":"Supplier_ShowHideSupplierStatistics","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"isVisible","in":"query","description":"if set to true [is visible].","required":true,"type":"boolean"}],"responses":{"204":{"description":"The visibility for supplier's transaction page statistics was set"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/suppliers/statistics/dashboard/visibility":{"get":{"tags":["Supplier"],"summary":"Get the visibility status of transaction statistics on the Supplier List page","operationId":"Supplier_GetSuppliersStatisticsVisibility","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"True is the statistics are visible for the supplier transaction page","schema":{"type":"boolean"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No supplier found"}},"deprecated":false},"put":{"tags":["Supplier"],"summary":"Toggle the visibility of the transaction statistics on the Supplier List page","operationId":"Supplier_ShowHideSuppliersStatistics","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"isVisible","in":"query","description":"if set to true [is visible].","required":true,"type":"boolean"}],"responses":{"204":{"description":"The visibility for supplier's transaction page statistics was set"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/suppliers":{"get":{"tags":["Supplier"],"summary":"Get the supplier list","operationId":"Supplier_GetPage","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"page","in":"query","required":false,"type":"integer","format":"int32"},{"name":"perpage","in":"query","required":false,"type":"integer","format":"int32"},{"name":"order","in":"query","required":false,"type":"string"},{"name":"sortby","in":"query","description":" 0 = Name,  1 = Code,  2 = TotalPaidAmount,  3 = OutstandingBalance","required":false,"type":"integer","format":"int32","enum":[0,1,2,3]},{"name":"namestartswith","in":"query","required":false,"type":"string"},{"name":"filterarchived","in":"query","required":false,"type":"boolean"},{"name":"searchtext","in":"query","required":false,"type":"string"},{"name":"startcreationdate","in":"query","required":false,"type":"string"},{"name":"endcreationdate","in":"query","required":false,"type":"string"},{"name":"skipperpagevalidation","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Paging[KashFlow.Accounting.DTO.Supplier.SupplierListResponse]"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No supplier found"}},"deprecated":false},"post":{"tags":["Supplier"],"summary":"Create a new supplier","operationId":"Supplier_Create","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"supplierRequest","in":"body","description":"Supplier object","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Supplier.SupplierRequest"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Supplier.SupplierResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No supplier found"}},"deprecated":false}},"/suppliers/{code}":{"get":{"tags":["Supplier"],"summary":"Get the supplier details, by code","operationId":"Supplier_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"code","in":"path","description":"Supplier code","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Supplier.SupplierResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No supplier found with that code"}},"deprecated":false},"put":{"tags":["Supplier"],"summary":"Update the supplier details, by code","operationId":"Supplier_Update","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"code","in":"path","description":"Supplier code","required":true,"type":"string"},{"name":"supplierRequest","in":"body","description":"Supplier object","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Supplier.SupplierRequest"}}],"responses":{"200":{"description":"Supplier was updated","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Supplier.SupplierResponse"}},"201":{"description":"Supplier updated with new Code","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Supplier.SupplierResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No supplier found"}},"deprecated":false},"delete":{"tags":["Supplier"],"summary":"Delete a supplier, by code","operationId":"Supplier_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"code","in":"path","description":"Supplier code","required":true,"type":"string"}],"responses":{"204":{"description":"Supplier deleted"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No supplier found with that code"}},"deprecated":false}},"/internal/suppliers/archive":{"put":{"tags":["Supplier"],"summary":"Archive multiple suppliers, by code","operationId":"Supplier_ArchiveSuppliers","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"supplierCodes","in":"body","description":"List of Supplier codes","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No supplier found"}},"deprecated":false}},"/internal/suppliers/supplierlist":{"delete":{"tags":["Supplier"],"summary":"Delete multiple suppliers, by code","operationId":"Supplier_DeleteSuppliers","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"supplierCodes","in":"body","description":"list of supplier Codes","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Deleted suppliers"},"400":{"description":"Invalid parameters","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.SupplierMassDeleteStatus"}}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/suppliers/suggestedcode":{"post":{"tags":["Supplier"],"summary":"Generate a supplier code, by name","operationId":"Supplier_GetSuggestedCodeFromName","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"supplierName","in":"query","description":"Supplier Name","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/internal/suppliers/supplierbulkinvoice":{"post":{"tags":["Supplier"],"summary":"Get Multiple suppliers invoices, by Supplier Codes","operationId":"Supplier_GetSupplierBulkInvoiceDetails","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"supplierCodes","in":"body","description":"list of supplier Supplier Codes","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.SupplierBulkInvoiceDetails"}}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/suppliers/confirm-to-delete":{"get":{"tags":["Supplier"],"summary":"Validate multiple suppliers, by code","operationId":"Supplier_ConfirmSuppliersToDelete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"supplierCodes","in":"query","description":"list of supplier Codes","required":true,"type":"string"}],"responses":{"200":{"description":"Confirm suppliers to delete"},"400":{"description":"Invalid parameters","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.SupplierMassDeleteStatus"}}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/internal/suppliers/valid-email":{"post":{"tags":["Supplier"],"summary":"Get suppliers by valid email","operationId":"Supplier_GetSuppliersByValidEmail","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"suppliersCode","in":"body","description":"The supplierscode.","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No customer found with that code"}},"deprecated":false}},"/suppliers/{code}/transactions":{"get":{"tags":["SupplierTransaction"],"summary":"Get the supplier transactions (purchase, purchase order, payment)","operationId":"SupplierTransaction_GetTransactions","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"code","in":"path","description":"The supplier code.","required":true,"type":"string"},{"name":"page","in":"query","description":"The page number","required":false,"type":"integer","format":"int32"},{"name":"perpage","in":"query","description":"The number of items per page.","required":false,"type":"integer","format":"int32"},{"name":"sortby","in":"query","description":"The Property to sort by 0 = Number,  1 = Date,  2 = Project,  3 = Amount,  4 = Status,  5 = Reference,  6 = Type","required":false,"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6]},{"name":"order","in":"query","description":"Sorting order (asc or desc) (default is asc)","required":false,"type":"string"},{"name":"typefilterby","in":"query","description":"The transaction filter by 0 = AllTypes,  2 = Payment,  4 = Purchase,  5 = Expense,  6 = CreditNote,  7 = PurchaseOrder","required":false,"type":"integer","format":"int32","enum":[0,2,4,5,6,7]},{"name":"projectfilterby","in":"query","description":"The project to filter by.","required":false,"type":"integer","format":"int32"},{"name":"statusfilterby","in":"query","description":"The status to filter by.","required":false,"type":"string"},{"name":"startdate","in":"query","required":false,"type":"string"},{"name":"enddate","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Paging[KashFlow.Accounting.Model.SupplierTransaction]"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No supplier found with that code"}},"deprecated":false}},"/supplierstatementtransaction":{"get":{"tags":["SupplierTransaction"],"summary":"Get Supplier Statement Transaction","operationId":"SupplierTransaction_GetSupplierStatementTransaction","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"suppliercode","in":"query","required":false,"type":"string"},{"name":"startdate","in":"query","required":false,"type":"string","format":"date-time"},{"name":"enddate","in":"query","required":false,"type":"string","format":"date-time"},{"name":"excludepaidinvoices","in":"query","required":false,"type":"integer","format":"int32"},{"name":"excludeopeningbalance","in":"query","required":false,"type":"integer","format":"int32"},{"name":"filterby","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/taxes":{"get":{"tags":["Tax"],"summary":"Get the taxes list","operationId":"Tax_GetTaxList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"type","in":"query","description":"Type","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/reports/trialbalance":{"get":{"tags":["TrialBalanceReport"],"summary":"This API allows a developer to retrieve Trial Balance. “TB” or “General Ledger”, is a list of all the Nominal Accounts (both revenue and capital) contained in the business.","operationId":"TrialBalanceReport_GetReportForUser","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"startDate","in":"query","description":"Start date from which the transactions are to be considered for nominal value calculations","required":true,"type":"string","format":"date-time"},{"name":"endDate","in":"query","description":"End date till which the transactions are to be considered for nominal value calculations","required":true,"type":"string","format":"date-time"},{"name":"excludeZeroBalance","in":"query","description":"Flag to indicate whether to include nominal with zero balance in the report or not. Default is true","required":false,"type":"boolean"},{"name":"includeOpeningBalance","in":"query","description":"Flag to indicate whether to include all the transactions from first transaction date or given start date. Default is true","required":false,"type":"boolean"},{"name":"accountingType","in":"query","description":"Accounting type 0 = Cash,  1 = Accrual","required":false,"type":"integer","format":"int32","enum":[0,1]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.TrialBalanceReport.TrialBalanceReport"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/reports/trialbalance/firsttransactiondate":{"get":{"tags":["TrialBalanceReport"],"summary":"Get the Trial Balance report from the first transaction date","operationId":"TrialBalanceReport_GetFirstTransactionDate","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.TrialBalanceReport.TrialBalanceReport"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/mileage/trips/tripcost":{"get":{"tags":["Trip"],"summary":"Get the cost of a trip","operationId":"Trip_GetTripCost","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"date","in":"query","required":true,"type":"string","format":"date-time"},{"name":"vehicletypeid","in":"query","required":true,"type":"string","format":"byte"},{"name":"distance","in":"query","required":true,"type":"number","format":"double"},{"name":"enginesizeid","in":"query","required":false,"type":"integer","format":"int32"},{"name":"enginetypeid","in":"query","required":false,"type":"integer","format":"int32"},{"name":"passenger","in":"query","required":false,"type":"integer","format":"int32"},{"name":"action","in":"query","description":" 0 = TripCost,  1 = AdvisoryTripCost","required":false,"type":"integer","format":"int32","enum":[0,1]},{"name":"claimvat","in":"query","required":false,"type":"boolean"},{"name":"isedittrip","in":"query","required":false,"type":"boolean"},{"name":"tripnumber","in":"query","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Trip.TripResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access ","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/mileage/trips/{number}":{"get":{"tags":["Trip"],"summary":"Get trip details, by ID","operationId":"Trip_GetTrip","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"Trip number","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Trip.TripResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access ","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"put":{"tags":["Trip"],"summary":"Update a trip, by ID","operationId":"Trip_UpdateTrip","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"Trip number","required":true,"type":"integer","format":"int32"},{"name":"tripBase","in":"body","description":"Trip object","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Base.TripBase"}}],"responses":{"200":{"description":"Updated trip successfully","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Trip.TripResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access ","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"delete":{"tags":["Trip"],"summary":"Delete a trip, by ID","operationId":"Trip_DeleteTrip","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"Trip number","required":true,"type":"integer","format":"int32"}],"responses":{"204":{"description":"Trip deleted"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access ","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/mileage/trips":{"get":{"tags":["Trip"],"summary":"Get a list of trips","operationId":"Trip_GetMileage","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"taxYear","in":"query","description":"Tax year in YYYY/YY format","required":true,"type":"string"},{"name":"page","in":"query","description":"Page number. (default is 1)","required":false,"type":"integer","format":"int32"},{"name":"perpage","in":"query","description":"PerPage is number of records per page. (default is 10)","required":false,"type":"integer","format":"int32"},{"name":"order","in":"query","description":"Sorting order (asc or desc) (default is asc)","required":false,"type":"string"},{"name":"sortcolumn","in":"query","description":"Sort By column. (default is 0 i.e.,Date) 0 = Date,  1 = VehicleType,  2 = Purpose,  3 = StartAddress,  4 = EndAddress,  5 = Distance,  6 = Value,  7 = Num,  8 = EmployeeName","required":false,"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8]},{"name":"vehicletype","in":"query","description":"Type of vehicle. (default is 0 i.e. All) 0 = All,  1 = CarOrVan,  2 = Motorcycle,  3 = ElectricCar","required":false,"type":"integer","format":"int32","enum":[0,1,2,3]},{"name":"employeeid","in":"query","description":"Employee Id. (default is All, 0 = Company User)","required":false,"type":"integer","format":"int32"},{"name":"searchtext","in":"query","description":"Search Trips by character with the provided string","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Paging[KashFlow.Accounting.DTO.Trip.TripResponse,KashFlow.Accounting.Model.MileagePagingMetadata]"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access ","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["Trip"],"summary":"Create a new trip","operationId":"Trip_CreateTrip","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"tripBase","in":"body","description":"Trip object","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Base.TripBase"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Trip.TripResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access ","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/mileage/trips/overview":{"get":{"tags":["Trip"],"summary":"Get Mileage overview for the tax year provided with Previous year","operationId":"Trip_GetMileageOverview","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"taxYear","in":"query","description":"Tax year as 2024/25","required":true,"type":"string"},{"name":"doComparePreviousYear","in":"query","description":"True/ false to fetch previous year mileage","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/users":{"get":{"tags":["User"],"summary":"Get a list of additional users","operationId":"User_GetList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false},"post":{"tags":["User"],"summary":"Create an additional user","operationId":"User_Create","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"user","in":"body","description":"User","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.User"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/users/{number}":{"get":{"tags":["User"],"summary":"Get the additional user details","operationId":"User_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"Number","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false},"put":{"tags":["User"],"summary":"Update the additional user, by ID","operationId":"User_Update","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"Number","required":true,"type":"integer","format":"int32"},{"name":"user","in":"body","description":"User","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.User"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false},"delete":{"tags":["User"],"summary":"Delete an additional user, by ID","operationId":"User_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"Number","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/users/activation/{activationGuid}":{"get":{"tags":["User"],"summary":"Get the additional user’s activation key","operationId":"User_GetActivationDetail","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"activationGuid","in":"path","description":"Activation Guid","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/users/activation/{activationGuid}/email":{"post":{"tags":["User"],"summary":"Create an activation key for the additional user","operationId":"User_SendActivationEmail","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"activationGuid","in":"path","description":"Activation Guid","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/users/{number}/activationemail":{"post":{"tags":["User"],"summary":"Resend the activation email to the additional user","operationId":"User_SendActivationEmailForCompanyUser","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"number","in":"path","description":"Number","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/users/activation/{activationGuid}/credential":{"put":{"tags":["User"],"summary":"Update the activation key for the additional user","operationId":"User_UpdateUserCredential","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"activationGuid","in":"path","description":"Activation Guid","required":true,"type":"string"},{"name":"credential","in":"body","description":"User credential","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.UserCredential"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/users/haslegacyusers":{"get":{"tags":["User"],"summary":"Check for expired users on the selected account","operationId":"User_HasLegacyUsers","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/vatliability":{"get":{"tags":["VatLiability"],"summary":"Get the aggregate VAT liability amount for the last 12 months","operationId":"VatLiability_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.VAT.AggregatedVatLiability"}}},"deprecated":false}},"/reports/vatmoss":{"get":{"tags":["VatMossReturn"],"summary":"Get the VAT Mini One Stop Shop (MOSS) returns list","operationId":"VatMossReturn_GetList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.VatMossReturn.VatMossReturnListResponse"}}}},"deprecated":false},"post":{"tags":["VatMossReturn"],"summary":"Create a new VAT Mini One Stop Shop (MOSS) return","operationId":"VatMossReturn_Create","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"reportBase","in":"body","description":"VAT MOSS Return Report","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Base.VatMossReturnBase"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.VatMossReturn.VatMossReturnResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access ","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/reports/vatmoss/{id}":{"get":{"tags":["VatMossReturn"],"summary":"Get the VAT Mini One Stop Shop (MOSS) Return Detail report for the submitted return, by ID","operationId":"VatMossReturn_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"VAT MOSS Return Id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.VatMossReturn.VatMossReturnResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access ","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No vat moss return found"}},"deprecated":false},"delete":{"tags":["VatMossReturn"],"summary":"Delete a VAT Mini One Stop Shop (MOSS) return","operationId":"VatMossReturn_Delete","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"VAT MOSS Return Id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"VAT MOSS Return deleted"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access ","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/reports/vatmoss/{id}/drilldown":{"get":{"tags":["VatMossReturn"],"summary":"Get the VAT Mini One Stop Shop (MOSS) Return Drilldown report for the submitted return, by ID","operationId":"VatMossReturn_GetVatMossDrillDownReturn","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"VAT MOSS Return Id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.VatMossDrillDown"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access ","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No vat moss return found"}},"deprecated":false}},"/reports/vatmoss/drilldown":{"get":{"tags":["VatMossReturn"],"summary":"Get the VAT Mini One Stop Shop (MOSS) Return Drilldown report for the open return, by quarter","operationId":"VatMossReturn_GetVatMossDrillDownReturnPreview","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"previewQuarter","in":"query","description":"Quarter for open return","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.VatMossDrillDown"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access ","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No vat moss return found"}},"deprecated":false}},"/reports/vatmoss/{guid}":{"get":{"tags":["VatMossReturnUnauthorized"],"summary":"Download the VAT Mini One Stop Shop (MOSS) Return Detail report","operationId":"VatMossReturnUnauthorized_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"guid","in":"path","description":"Vatmossreturn Key","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/reports/vat/zerorated":{"get":{"tags":["VatReport"],"summary":"This API allows a developer to get zero rated VAT Report. This report provides 0% and NA VAT Transactions for any given period.","operationId":"VatReport_GetVatExemptZeroRatedReport","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"startDate","in":"query","description":"Start date from which the entities with 0% or NA VAT rate line items should be retrieved","required":true,"type":"string","format":"date-time"},{"name":"endDate","in":"query","description":"End date till which the entities with 0% or NA VAT rate line items should be retrieved","required":true,"type":"string","format":"date-time"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.VatReports.VatExemptZeroRatedReport"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/reports/vat/salesreport":{"get":{"tags":["VatReport"],"summary":"Get ec and non-ec sales report","operationId":"VatReport_GetSalesReport","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"reporttype","in":"query","description":" 1 = EC,  2 = NonEC","required":false,"type":"integer","format":"int32","enum":[1,2]},{"name":"bringforwardolderunreconcileditems","in":"query","required":false,"type":"boolean"},{"name":"startdate","in":"query","required":true,"type":"string"},{"name":"enddate","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.VatReports.SalesReportResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/reports/vat/trading-details":{"get":{"tags":["VatReport"],"summary":"Get Vat return trading details","operationId":"VatReport_GetVatReturnTradingDetails","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"startDate","in":"query","description":"Start date","required":true,"type":"string"},{"name":"endDate","in":"query","description":"End date","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.VatReports.VatTradingDetails"}}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/vatreturns/{id}":{"get":{"tags":["VatReturn"],"summary":"Get the VAT return details, by period key","operationId":"VatReturn_GetVatReturn","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"VAT return id","required":true,"type":"integer","format":"int64"},{"name":"status","in":"query","description":"VAT return is open or submitted 0 = Open,  1 = Pending,  2 = MarkedAsSubmitted,  3 = SubmittedToHMRC,  4 = Failed","required":true,"type":"integer","format":"int32","enum":["Open","Pending","Marked as Submitted","Submitted to HMRC","Failed"]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.VAT.VatReturnWithBoxValues"}},"400":{"description":"VAT return id provided is incorrect"},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No VAT return was found with given id and status"}},"deprecated":false},"put":{"tags":["VatReturn"],"summary":"Update a VAT return","operationId":"VatReturn_UpdateReturn","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"VAT return id","required":true,"type":"integer","format":"int64"},{"name":"action","in":"query","description":"action 0 = EditDate,  1 = SubmitToHMRC,  2 = ResubmitToHMRC,  3 = MarkAsSubmitted","required":true,"type":"integer","format":"int32","enum":[0,1,2,3]},{"name":"vatReturn","in":"body","description":"VAT return detail","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.VAT.VatReturnWithBoxValues"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.VAT.VatReturns"}},"400":{"description":"Please provide either resubmittohmrc/editdate as action","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["VatReturn"],"summary":"Submit the VAT return, by period key","operationId":"VatReturn_SubmitReturn","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"VAT return id","required":true,"type":"integer","format":"int64"},{"name":"action","in":"query","description":"action(submittohmrc or markassubmitted) 0 = EditDate,  1 = SubmitToHMRC,  2 = ResubmitToHMRC,  3 = MarkAsSubmitted","required":true,"type":"integer","format":"int32","enum":[0,1,2,3]},{"name":"vatReturnRequest","in":"body","description":"VAT return detail","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.VatReturn.VatReturnRequest"}}],"responses":{"204":{"description":"VAT return submitted"},"400":{"description":"Please provide either submittohmrc or markassubmitted as action"},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"delete":{"tags":["VatReturn"],"summary":"Delete a VAT return","operationId":"VatReturn_DeleteVatReturn","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"VAT return id","required":true,"type":"integer","format":"int64"}],"responses":{"204":{"description":"VAT return successfully deleted"},"400":{"description":"You can only delete the latest open VAT return while not connected to MTD"},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/vatreturns":{"get":{"tags":["VatReturn"],"summary":"Get a list of VAT returns","operationId":"VatReturn_GetVatReturnList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"year","in":"query","description":"Year (default is 0 for all years)","required":false,"type":"integer","format":"int32"},{"name":"status","in":"query","description":"Vat return status (default is all, which will return everything apart from open status) 0 = All,  1 = Open,  2 = Submitted,  3 = SubmittedToHMRC,  4 = MarkedAsSubmitted,  5 = Failed,  6 = Pending","required":false,"type":"integer","format":"int32","enum":["all","open","submitted","submittedtohmrc","markedassubmitted","failed","pending"]},{"name":"order","in":"query","description":"Sorting order on enddate (default is desc) 0 = Asc,  1 = Desc","required":false,"type":"integer","format":"int32","enum":[0,1]},{"name":"page","in":"query","description":"Page number (default is 0)","required":false,"type":"integer","format":"int32"},{"name":"pagesize","in":"query","description":"PerPage is number of records per page (default is 0),\r\n            both page and pagesize default values will return all the records","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.VAT.VatReturns"}},"400":{"description":"Provided year should be zero for all records or greater than 1990 and should not be more than 4 digits"},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false},"post":{"tags":["VatReturn"],"summary":"Create a VAT return","operationId":"VatReturn_CreateReturn","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"vatReturnBase","in":"body","description":"vat return detail","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Base.VatReturnBase"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.VAT.VatReturnWithBoxValues"}},"400":{"description":"Please review the vatReturn properties"},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/vatreturns/Years":{"get":{"tags":["VatReturn"],"summary":"Get a list of submitted and open VAT returns, by year","operationId":"VatReturn_GetVatReturnYearList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/vatreturns/{id}/paidstatus":{"put":{"tags":["VatReturn"],"summary":"Mark an open VAT return as paid","operationId":"VatReturn_SetVatReturnPaidStatus","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"VAT return id","required":true,"type":"integer","format":"int64"}],"responses":{"204":{"description":"Paid status for VAT return set to Paid"},"400":{"description":"VAT return Id provided cannot be less than zero"},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"VAT return does not exist for the provided id and status"}},"deprecated":false},"delete":{"tags":["VatReturn"],"summary":"Mark the paid VAT return as open","operationId":"VatReturn_UnsetVatReturnPaidStatus","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"VAT return id","required":true,"type":"integer","format":"int64"}],"responses":{"204":{"description":"Paid status for VAT return set to Unpaid"},"400":{"description":"VAT return Id provided cannot be less than zero"},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"VAT return does not exist for the provided id and status"}},"deprecated":false}},"/vatreturns/{id}/details":{"get":{"tags":["VatReturn"],"summary":"Get the transactions in the VAT return, by period key","operationId":"VatReturn_GetVatReturnBreakdown","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"VAT return id","required":true,"type":"integer","format":"int64"},{"name":"status","in":"query","description":"VAT return is open or submitted 0 = Open,  1 = Pending,  2 = MarkedAsSubmitted,  3 = SubmittedToHMRC,  4 = Failed","required":true,"type":"integer","format":"int32","enum":["Open","Pending","Marked as Submitted","Submitted to HMRC","Failed"]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.VAT.VATReturnBreakdown"}},"400":{"description":"VAT return id provided is incorrect"},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No VAT return was found with given id and status"}},"deprecated":false}},"/vatreturns/{id}/csv":{"get":{"tags":["VatReturn"],"summary":"Get the VAT return details in CSV format, by period key","operationId":"VatReturn_GetVATReturnBreakdownCSV","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"VAT return id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.VAT.VATReturnBreakdown"}},"400":{"description":"VAT return id provided is incorrect"},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No CSV found with given VAT Return id"}},"deprecated":false}},"/vatreturns/{id}/markasopen":{"put":{"tags":["VatReturn"],"summary":"Mark a paid VAT return as open","operationId":"VatReturn_MarkVatReturnAsOpen","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"VAT return id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"VAT return successfully marked as open"},"400":{"description":"VAT return id provided is incorrect"},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"No VAT return was found with given id"}},"deprecated":false}},"/vatreturns/details":{"get":{"tags":["VatReturn"],"summary":"This API allows a developer to get VAT return details by KashFlow Id or period Id .","operationId":"VatReturn_GetVatReturnDetails","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"fetchby","in":"query","description":"Whether you want to fetch the report by Id, period Id or date range. Default is Id 0 = Id,  1 = PeriodId","required":true,"type":"integer","format":"int32","enum":[0,1]},{"name":"status","in":"query","description":"VAT Return status. Possible values are: \r\n            0 = Open\r\n            1 = Pending\r\n            2 = MarkedAsSubmitted\r\n            3 = SubmittedToHMRC\r\n            4 = Failed\r\n            Default is Open 0 = Open,  1 = Pending,  2 = MarkedAsSubmitted,  3 = SubmittedToHMRC,  4 = Failed","required":true,"type":"integer","format":"int32","enum":["Open","Pending","Marked as Submitted","Submitted to HMRC","Failed"]},{"name":"id","in":"query","description":"System generated unique Id for the VAT Return.","required":false,"type":"integer","format":"int64"},{"name":"periodId","in":"query","description":"HMRC generated unique Id for the VAT Return.","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.VAT.VATReturnBreakdown"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/vatreturns/summary":{"get":{"tags":["VatReturn"],"summary":"Get VAT return summary by Id or period Id","operationId":"VatReturn_GetVatReturnSummary","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"fetchby","in":"query","description":"Whether you want to fetch the report by Id, period Id or date range. Default is Id 0 = Id,  1 = PeriodId,  2 = Daterange","required":true,"type":"integer","format":"int32","enum":[0,1,2]},{"name":"status","in":"query","description":"VAT Return status. Possible values are: \r\n            0 = Open\r\n            1 = Pending\r\n            2 = MarkedAsSubmitted\r\n            3 = SubmittedToHMRC\r\n            4 = Failed\r\n            Default is Open 0 = Open,  1 = Pending,  2 = MarkedAsSubmitted,  3 = SubmittedToHMRC,  4 = Failed","required":true,"type":"integer","format":"int32","enum":["Open","Pending","Marked as Submitted","Submitted to HMRC","Failed"]},{"name":"id","in":"query","description":"System generated unique Id for the VAT Return.","required":false,"type":"integer","format":"int64"},{"name":"periodId","in":"query","description":"HMRC generated unique Id for the VAT Return.","required":false,"type":"string"},{"name":"startDate","in":"query","description":"Start date of a VAT Return period in the format YYYY-MM-DD","required":false,"type":"string"},{"name":"endDate","in":"query","description":"End date of a VAT Return period in the format YYYY-MM-DD","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.VAT.VatReturnWithBoxValues"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/settings/vat":{"get":{"tags":["VatSetting"],"summary":"Get the VAT settings","operationId":"VatSetting_GetVatSettings","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Settings.VatSettings"}}},"deprecated":false},"put":{"tags":["VatSetting"],"summary":"Update the VAT settings","operationId":"VatSetting_UpdateVatSettings","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"settings","in":"body","description":"Update vat settings to be updated","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Settings.UpdateVatSettingsRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Settings.VatSettings"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/settings/vat/displayMtdRecommendedModal":{"put":{"tags":["VatSetting"],"summary":"Update the MTD Recommended  flag for VAT settings","operationId":"VatSetting_UpdateVatSettingsDisplayMtdRecommendedModal","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"201":{"description":"VatSettings updated","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"204":{"description":"Display Mtd Recommended Modal Flag is set"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/settings/VATNumber":{"get":{"tags":["VatSetting"],"summary":"Validate the VAT number","operationId":"VatSetting_Validate","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"vatNumber","in":"query","description":"VAT Number","required":true,"type":"string"}],"responses":{"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/settings/vatrates":{"get":{"tags":["VatSetting"],"summary":"Get the VAT rates","operationId":"VatSetting_GetVatRatesforUser","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Settings.VatSettings"}}},"deprecated":false}},"/vatrates":{"get":{"tags":["VatSetting"],"summary":"Get the VAT rates","operationId":"VatSetting_GetVatRatesforUser","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.Settings.VatSettings"}}},"deprecated":false}},"/vat/settings":{"get":{"tags":["VatSettings"],"summary":"Gets the user VAT settings.","operationId":"VatSettings_GetVatSettings","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"VAT settings returned successfully.","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.VAT.VatSettingsResponse"}}},"deprecated":false},"put":{"tags":["VatSettings"],"summary":"Updates the user VAT settings.","operationId":"VatSettings_UpdateVatSettings","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"vatSettings","in":"body","description":"The VAT settings to be updated.","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.VAT.VatSettingsRequest"}}],"responses":{"200":{"description":"VAT settings updated successfully.","schema":{"$ref":"#/definitions/KashFlow.Accounting.Model.VAT.VatSettingsRequest"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/vat/settings/vatrates":{"get":{"tags":["VatSettings"],"summary":"Gets the user VAT rates.","operationId":"VatSettings_GetVatRates","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"VAT rates returned successfully.","schema":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.VatRates"}}}},"deprecated":false}},"/vat/settings/vatrates/{vatRate}":{"post":{"tags":["VatSettings"],"summary":"Create new a VAT rate","operationId":"VatSettings_CreateVatRate","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"vatRate","in":"path","description":"VAT Id","required":true,"type":"number","format":"double"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"201":{"description":"VAT rate created successfully"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/vat/settings/vatrates/{vatRateId}":{"delete":{"tags":["VatSettings"],"summary":"Delete a VAT rate, by vatRateId","operationId":"VatSettings_DeleteVatRate","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"vatRateId","in":"path","description":"VAT Id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"VAT rate deleted"},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"VAT Rate Id not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/vatsubmissiongateway/disconnect":{"delete":{"tags":["VatSubmissionGateway"],"summary":"Delete the MTD VAT API access token from the database","operationId":"VatSubmissionGateway_Disconnect","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"NoContent"}},"deprecated":false}},"/vatsubmissiongateway/auth_url":{"get":{"tags":["VatSubmissionGateway"],"summary":"Get the authorization URL for the MTD VAT API","operationId":"VatSubmissionGateway_GetAuthorizationUrl","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"referralUrl","in":"query","description":"referral Url","required":true,"type":"string"}],"responses":{"200":{"description":"Returns hmrc authorization url"},"404":{"description":"Referral url cannot be empty","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/vatsubmissiongateway/accesstoken":{"get":{"tags":["VatSubmissionGateway"],"summary":"Get the MTD VAT API access token for authorization","operationId":"VatSubmissionGateway_GetAcessToken","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"state","in":"query","description":"The value of the state parameter you provided in the authorization request, whether or not authorization is successful.","required":true,"type":"string"},{"name":"code","in":"query","description":"The authorization code, if authorization is successful","required":false,"type":"string"},{"name":"error","in":"query","description":"Always access_denied, if authorization failed.","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/viapost/balance":{"get":{"tags":["ViaPost"],"summary":"Get the ViaPost account balance","operationId":"ViaPost_GetBalance","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"Balance","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.ViaPost.ViaPostBalance"}}},"deprecated":false}},"/viapost":{"post":{"tags":["ViaPost"],"summary":"Send a file using ViaPost","operationId":"ViaPost_Post","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"viaPostBase","in":"body","required":true,"schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Base.ViaPostBase"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/KashFlow.Accounting.DTO.ViaPost.ViaPostResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/internal/{objectType}/{objectNumber}/withholdingtaxdeduction":{"post":{"tags":["WithholdingTaxDeduction"],"summary":"Apply witholding tax deduction to an Invoice/Purchase","operationId":"WithholdingTaxDeduction_ApplyWithholdingTaxDeduction","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"objectType","in":"path","description":"Object Type: Invoice or purchase","required":true,"type":"string"},{"name":"objectNumber","in":"path","description":"Object Number","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/reports/yearend":{"post":{"tags":["YearEndReport"],"summary":"Create the Year End report for the accounting period ID","operationId":"YearEndReport_CreateJournalForAccountingPeriod","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accountingPeriodId","in":"query","description":"ID of the accounting period for which the year-end journal needs to be created","required":true,"type":"integer","format":"int32"},{"name":"nominalCode","in":"query","description":"Nominal code against which the retained profit/loss value needs to be logged in the year end journal","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"401":{"description":"Unauthorized Access","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}},"404":{"description":"Entity not found","schema":{"$ref":"#/definitions/KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse"}}},"deprecated":false}},"/reports/yearend/nominalcode":{"post":{"tags":["YearEndReport"],"summary":"Create a nominal code for the Year End Journal","operationId":"YearEndReport_CreateJournalForAccountingPeriod","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}}},"definitions":{"System.Object":{"type":"object","properties":{}},"KashFlow.Accounting.Model.AccountantsAccess.AccountantAccess":{"type":"object","properties":{"PartnerId":{"format":"int32","type":"integer"},"PartnerCompanyName":{"type":"string"},"PartnerEmail":{"type":"string"}}},"KashFlow.Accounting.RestApi.ExceptionHandler.ErrorResponse":{"type":"object","properties":{"Message":{"type":"string"},"Error":{"type":"string"}}},"KashFlow.Accounting.Model.AccountantsAccess.AccountantLookupResponse":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"CompanyName":{"type":"string"},"Telephone":{"type":"string"},"Address":{"type":"string"},"Email":{"type":"string"}}},"KashFlow.Accounting.DTO.Response.AccountingPeriodResponse":{"required":["StartDate","EndDate"],"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"JournalRef":{"type":"string"},"IsCurrentPeriod":{"type":"boolean"},"StartDate":{"format":"date-time","type":"string"},"EndDate":{"format":"date-time","type":"string"},"YearEndJournalId":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.DTO.Wrapper.AccountingPeriodWrapper":{"type":"object","properties":{"AccountingPeriodBase":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Base.AccountingPeriodBase"}}}},"KashFlow.Accounting.DTO.Base.AccountingPeriodBase":{"required":["StartDate","EndDate"],"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"StartDate":{"format":"date-time","type":"string"},"EndDate":{"format":"date-time","type":"string"},"YearEndJournalId":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.AccountSummary":{"type":"object","properties":{"Display":{"$ref":"#/definitions/KashFlow.Accounting.Model.AccountSummaryDisplay"},"Messages":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Message"}},"Financial":{"$ref":"#/definitions/KashFlow.Accounting.Model.FinancialSummary"},"DataImports":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.DataImport"}},"ReferralDetails":{"$ref":"#/definitions/KashFlow.Accounting.Model.Referral"},"QuotesSummary":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.QuoteSummary"}},"OnBoarderDetails":{"$ref":"#/definitions/KashFlow.Accounting.Model.Onboarder"},"Announcement":{"$ref":"#/definitions/KashFlow.Accounting.Model.Announcement"},"InAppPromotion":{"$ref":"#/definitions/KashFlow.Accounting.Model.InAppPromotion"}}},"KashFlow.Accounting.Model.AccountSummaryDisplay":{"type":"object","properties":{"ShowGettingStartedSection":{"type":"boolean"},"ShowMessages":{"type":"boolean"},"ShowFinancialSummary":{"type":"boolean"},"ShowFinancialGraph":{"type":"boolean"},"ShowQuickLinks":{"type":"boolean"},"ShowDoYouKnowSection":{"type":"boolean"},"ShowVATLiability":{"type":"boolean"},"SuppressVATWarning":{"type":"boolean"},"ShowChangeLog":{"type":"boolean"},"ShowReferral":{"type":"boolean"},"ShowQuotesSummary":{"type":"boolean"},"ShowAnnouncement":{"type":"boolean"},"ShowPaymentProcessor":{"type":"boolean"},"ShowMTDOverview":{"type":"boolean"},"ShowInAppPromotion":{"type":"boolean"},"ShowUnipaasEwalletDisplaySetting":{"type":"boolean"},"ShowUnipaasEwalletPromotion":{"type":"boolean"},"ShowBusinessWidget":{"type":"boolean"},"VatThresholdStatus":{"type":"boolean"},"ShowItsaThresholdStatus":{"type":"boolean"}}},"KashFlow.Accounting.Model.Message":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Title":{"type":"string"},"Text":{"type":"string"}}},"KashFlow.Accounting.Model.FinancialSummary":{"type":"object","properties":{"BankAccounts":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.BankAccountLite"}},"AgedDebtorsBalance":{"format":"double","type":"number"},"AgedCreditorsBalance":{"format":"double","type":"number"},"OverdueInvoicesBalance":{"format":"double","type":"number"},"OverduePurchasesBalance":{"format":"double","type":"number"},"VATLiability":{"$ref":"#/definitions/KashFlow.Accounting.Model.VatDetails"},"ReportType":{"type":"string"},"ReportsData":{"$ref":"#/definitions/KashFlow.Accounting.Model.ReportsData"}}},"KashFlow.Accounting.Model.DataImport":{"type":"object","properties":{"ProfileId":{"format":"int32","type":"integer"},"SubscriberImportAccountId":{"format":"int32","type":"integer"},"ProfileName":{"type":"string"},"LastStatus":{"type":"string"},"LastStatusMessage":{"type":"string"},"LastCheckedDate":{"type":"string"},"TransactionCount":{"format":"int32","type":"integer"},"Source":{"type":"string"},"PaymentAccountId":{"format":"int32","type":"integer"},"EmailConfirmed":{"type":"boolean"}}},"KashFlow.Accounting.Model.Referral":{"type":"object","properties":{"AffiliateId":{"format":"int32","type":"integer"},"PromotionalCode":{"type":"string"},"HomeLink":{"type":"string"},"RegistrationLink":{"type":"string"},"PayingUsers":{"format":"int32","type":"integer"},"TrailingUsers":{"format":"int32","type":"integer"},"AmountOwed":{"format":"double","type":"number"},"AmountEarned":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.QuoteSummary":{"type":"object","properties":{"CategoryNumber":{"format":"int32","type":"integer"},"CategoryName":{"type":"string"},"QuotesCount":{"format":"int32","type":"integer"},"Total":{"format":"double","type":"number"},"CategoryIcon":{"type":"string"}}},"KashFlow.Accounting.Model.Onboarder":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"DisplayName":{"type":"string"},"CssName":{"type":"string"},"PhoneNumber":{"type":"string"}}},"KashFlow.Accounting.Model.Announcement":{"type":"object","properties":{"Head":{"type":"string"},"Message":{"type":"string"}}},"KashFlow.Accounting.Model.InAppPromotion":{"type":"object","properties":{"UnipaasConnectionStatus":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.BankAccountLite":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Name":{"type":"string"},"Balance":{"format":"double","type":"number"},"IconPath":{"type":"string"},"BalanceOverviewByMonth":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ValueByMonth"}}}},"KashFlow.Accounting.Model.VatDetails":{"type":"object","properties":{"PeriodStartDate":{"type":"string"},"PeriodEndDate":{"type":"string"},"Amount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ReportsData":{"type":"object","properties":{"SalesGrowth":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ValueByMonth"}},"ProfitAndLoss":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ProfitAndLossStatisticsByMonth"}},"IncomeBySource":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.SourceStatistics"}}}},"KashFlow.Accounting.Model.ValueByMonth":{"type":"object","properties":{"Month":{"type":"string"},"Amount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ProfitAndLossStatisticsByMonth":{"type":"object","properties":{"Month":{"type":"string"},"Statistics":{"$ref":"#/definitions/KashFlow.Accounting.Model.ProfitAndLossStatistics"}}},"KashFlow.Accounting.Model.SourceStatistics":{"type":"object","properties":{"SourceName":{"type":"string"},"IncomeByMonth":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ValueByMonth"}}}},"KashFlow.Accounting.Model.ProfitAndLossStatistics":{"type":"object","properties":{"Turnover":{"format":"double","type":"number"},"Gross":{"format":"double","type":"number"},"Net":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.IdealPostcodes.PostcodeResponse":{"type":"object","properties":{"Result":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.IdealPostcodes.PostcodeResult"}},"Code":{"format":"int32","type":"integer"},"Message":{"type":"string"},"Total":{"format":"int32","type":"integer"},"Page":{"format":"int32","type":"integer"},"Limit":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.IdealPostcodes.PostcodeResult":{"type":"object","properties":{"Postcode":{"type":"string"},"Postcode_inward":{"type":"string"},"Postcode_outward":{"type":"string"},"Post_town":{"type":"string"},"Dependant_locality":{"type":"string"},"Double_dependant_locality":{"type":"string"},"Thoroughfare":{"type":"string"},"Dependant_thoroughfare":{"type":"string"},"Building_number":{"type":"string"},"Building_name":{"type":"string"},"Sub_building_name":{"type":"string"},"Po_box":{"type":"string"},"Department_name":{"type":"string"},"Organisation_name":{"type":"string"},"Udprn":{"format":"int32","type":"integer"},"Umprn":{"type":"string"},"Postcode_type":{"type":"string"},"Su_organisation_indicator":{"type":"string"},"Delivery_point_suffix":{"type":"string"},"Line_1":{"type":"string"},"Line_2":{"type":"string"},"Line_3":{"type":"string"},"Premise":{"type":"string"},"Longitude":{"format":"double","type":"number"},"Latitude":{"format":"double","type":"number"},"Eastings":{"format":"int32","type":"integer"},"Northings":{"format":"int32","type":"integer"},"Country":{"type":"string"},"Traditional_county":{"type":"string"},"Administrative_county":{"type":"string"},"Postal_county":{"type":"string"},"County":{"type":"string"},"District":{"type":"string"},"Ward":{"type":"string"},"Uprn":{"type":"string"}}},"KashFlow.Accounting.RestApi.Parameters.AdvancePaymentFilterParameters":{"type":"object","properties":{"Page":{"format":"int32","description":"Page number. (default is 1)","type":"integer"},"PerPage":{"format":"int32","description":"PerPage is number of records per page. (default is 10)","type":"integer"},"Order":{"description":"Sorting order (asc or desc) (default is asc)","type":"string"},"SortBy":{"format":"int32","description":"Sort By Transactoin Date or Amount or Comment. (default is transactoin date) 1 = TransactionDate,  2 = Amount,  3 = Comment","enum":[1,2,3],"type":"integer"}}},"KashFlow.Accounting.Model.Paging[KashFlow.Accounting.Model.AdvancePayment]":{"required":["Data"],"type":"object","properties":{"MetaData":{"$ref":"#/definitions/KashFlow.Accounting.Model.PagingMetadata"},"Data":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.AdvancePayment"}}}},"KashFlow.Accounting.Model.PagingMetadata":{"type":"object","properties":{"TotalRecords":{"format":"int32","type":"integer"},"FirstPageUrl":{"type":"string"},"LastPageUrl":{"type":"string"},"PreviousPageUrl":{"type":"string"},"NextPageUrl":{"type":"string"},"TotalAmount":{"format":"double","type":"number"},"InvoiceLimitReached":{"type":"boolean"}}},"KashFlow.Accounting.Model.AdvancePayment":{"type":"object","properties":{"Id":{"format":"int64","type":"integer"},"BankAccountId":{"format":"int32","type":"integer"},"Amount":{"format":"double","type":"number"},"Date":{"type":"string"},"Comment":{"type":"string"}}},"KashFlow.Accounting.Model.Reports.AgedCreditorsReport.AgedCreditorsReport":{"required":["Period1","Period2","Period3","Period4","Period1Total","Period2Total","Period3Total","Period4Total","RestTotal","BalanceTotal","Items"],"type":"object","properties":{"Period1":{"type":"string"},"Period2":{"type":"string"},"Period3":{"type":"string"},"Period4":{"type":"string"},"Period1Total":{"format":"double","type":"number"},"Period2Total":{"format":"double","type":"number"},"Period3Total":{"format":"double","type":"number"},"Period4Total":{"format":"double","type":"number"},"RestTotal":{"format":"double","type":"number"},"BalanceTotal":{"format":"double","type":"number"},"Items":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.AgedCreditorsReport.AgedCreditor"}}}},"KashFlow.Accounting.Model.Reports.AgedCreditorsReport.AgedCreditor":{"required":["Period1","Period2","Period3","Period4","Rest","Balance","SupplierId","SupplierCode","SupplierName"],"type":"object","properties":{"Period1":{"format":"double","type":"number"},"Period2":{"format":"double","type":"number"},"Period3":{"format":"double","type":"number"},"Period4":{"format":"double","type":"number"},"Rest":{"format":"double","type":"number"},"Balance":{"format":"double","type":"number"},"SupplierId":{"format":"int32","type":"integer"},"SupplierCode":{"type":"string"},"SupplierName":{"type":"string"},"ReportBreakdown":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.AgedReportBreakdownItem"}}}},"KashFlow.Accounting.Model.Reports.AgedReportBreakdownItem":{"required":["ParentId","EntityId","EntityNumber","Date","Balance","Period1","Period2","Period3","Period4","Rest","IsBank"],"type":"object","properties":{"ParentId":{"format":"int32","type":"integer"},"EntityId":{"format":"int32","type":"integer"},"EntityNumber":{"format":"int32","type":"integer"},"Date":{"type":"string"},"Ref":{"type":"string"},"Balance":{"format":"double","type":"number"},"Period1":{"format":"double","type":"number"},"Period2":{"format":"double","type":"number"},"Period3":{"format":"double","type":"number"},"Period4":{"format":"double","type":"number"},"Rest":{"format":"double","type":"number"},"IsBank":{"type":"boolean"},"BankAccountId":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.Reports.AgedDebtorsReport.AgedDebtorsReport":{"required":["Period1","Period2","Period3","Period4","Period1Total","Period2Total","Period3Total","Period4Total","RestTotal","BalanceTotal"],"type":"object","properties":{"Period1":{"type":"string"},"Period2":{"type":"string"},"Period3":{"type":"string"},"Period4":{"type":"string"},"Period1Total":{"format":"double","type":"number"},"Period2Total":{"format":"double","type":"number"},"Period3Total":{"format":"double","type":"number"},"Period4Total":{"format":"double","type":"number"},"RestTotal":{"format":"double","type":"number"},"BalanceTotal":{"format":"double","type":"number"},"Items":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.AgedDebtorsReport.AgedDebtor"}}}},"KashFlow.Accounting.Model.Reports.AgedDebtorsReport.AgedDebtor":{"required":["Period1","Period2","Period3","Period4","Rest","Balance","CustomerId","CustomerCode","CustomerName"],"type":"object","properties":{"Period1":{"format":"double","type":"number"},"Period2":{"format":"double","type":"number"},"Period3":{"format":"double","type":"number"},"Period4":{"format":"double","type":"number"},"Rest":{"format":"double","type":"number"},"Balance":{"format":"double","type":"number"},"CustomerId":{"format":"int32","type":"integer"},"CustomerCode":{"type":"string"},"CustomerName":{"type":"string"},"ReportBreakdown":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.AgedReportBreakdownItem"}}}},"KashFlow.Accounting.Model.IPAddress":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Address":{"type":"string"},"Comment":{"type":"string"}}},"KashFlow.Accounting.Model.IPAddressBase":{"type":"object","properties":{"Address":{"type":"string"},"Comment":{"type":"string"}}},"KashFlow.Accounting.DTO.Authentication.ExternTokenAuthenticationResponse":{"type":"object","properties":{"TenantId":{"format":"int32","type":"integer"},"SessionToken":{"type":"string"},"MemorableWordList":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Authentication.MemorableWordPositionAndValue"}},"KeepUserLoggedIn":{"type":"boolean"},"MemorableWordPositions":{"type":"string"},"IsLockedOut":{"type":"boolean"},"CompanyUserId":{"format":"int32","type":"integer"},"CompanyId":{"format":"int32","type":"integer"},"PartnerId":{"format":"int32","type":"integer"},"ConnectedUserPartnerId":{"format":"int32","type":"integer"},"ClientManagerId":{"format":"int32","type":"integer"},"PartnerBrandingOptOut":{"type":"boolean"},"PackageName":{"type":"string"},"IsPackageRestricted":{"type":"boolean"},"SubscriptionExpired":{"type":"boolean"},"IntegrationsSettings":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Authentication.IntegrationsSettings"},"HasTemporaryPassword":{"type":"boolean"},"Disabled":{"type":"boolean"},"CompanyUserFullName":{"type":"string"},"EmailId":{"type":"string"},"PartnerCompanyUserId":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.DTO.Authentication.MemorableWordPositionAndValue":{"type":"object","properties":{"Position":{"format":"int32","type":"integer"},"Value":{"type":"string"}}},"KashFlow.Accounting.DTO.Authentication.IntegrationsSettings":{"type":"object","properties":{"ReceiptBankIntegrationSettings":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Authentication.ReceiptBankIntegrationSettings"}}},"KashFlow.Accounting.DTO.Authentication.ReceiptBankIntegrationSettings":{"type":"object","properties":{"IsReceiptBankIntegrationRequested":{"type":"boolean"},"IsReceiptBankIntegrationCompleted":{"type":"boolean"},"IsReceiptBankIntegrationNotifiedToUser":{"type":"boolean"},"ReceiptBankIntegration_NotifiedUser_Progress":{"type":"boolean"},"ReceiptBankIntegration_NotifiedUser_Failure":{"type":"boolean"},"ReceiptBankIntegration_Failed":{"type":"boolean"},"ReceiptBankIntegration_FailedAttempts":{"format":"int32","type":"integer"},"ReceiptBankIntegration_FailureReason":{"type":"string"},"RBIntegration_Failure_BadRequest":{"type":"boolean"},"ReceiptBankAccountEmailId":{"type":"string"}}},"KashFlow.Accounting.DTO.Authentication.AuthenticationDetailsRequest":{"type":"object","properties":{"UserName":{"type":"string"},"Password":{"type":"string"}}},"KashFlow.Accounting.DTO.Authentication.AuthenticationDetailsResponse":{"type":"object","properties":{"TenantId":{"format":"int32","type":"integer"},"TemporaryToken":{"type":"string"},"MemorableWordList":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Authentication.MemorableWordPositionAndValue"}},"KeepUserLoggedIn":{"type":"boolean"},"MemorableWordPositions":{"type":"string"},"IsLockedOut":{"type":"boolean"},"CompanyUserId":{"format":"int32","type":"integer"},"CompanyId":{"format":"int32","type":"integer"},"PartnerId":{"format":"int32","type":"integer"},"ConnectedUserPartnerId":{"format":"int32","type":"integer"},"ClientManagerId":{"format":"int32","type":"integer"},"PartnerBrandingOptOut":{"type":"boolean"},"PackageName":{"type":"string"},"IsPackageRestricted":{"type":"boolean"},"SubscriptionExpired":{"type":"boolean"},"IntegrationsSettings":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Authentication.IntegrationsSettings"},"HasTemporaryPassword":{"type":"boolean"},"Disabled":{"type":"boolean"},"CompanyUserFullName":{"type":"string"},"EmailId":{"type":"string"},"PartnerCompanyUserId":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.DTO.Authentication.PermanentTokenAuthenticationDetailsRequest":{"type":"object","properties":{"TemporaryToken":{"type":"string"},"MemorableWordList":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Authentication.MemorableWordPositionAndValue"}},"KeepUserLoggedIn":{"type":"boolean"}}},"KashFlow.Accounting.DTO.Authentication.PermanentTokenAuthenticationDetailsResponse":{"type":"object","properties":{"TenantId":{"format":"int32","type":"integer"},"SessionToken":{"type":"string"},"StartPageUrl":{"type":"string"},"SubscriptionExpiryDate":{"type":"string"},"KeepUserLoggedIn":{"type":"boolean"},"MemorableWordPositions":{"type":"string"},"IsLockedOut":{"type":"boolean"},"CompanyUserId":{"format":"int32","type":"integer"},"CompanyId":{"format":"int32","type":"integer"},"PartnerId":{"format":"int32","type":"integer"},"ConnectedUserPartnerId":{"format":"int32","type":"integer"},"ClientManagerId":{"format":"int32","type":"integer"},"PartnerBrandingOptOut":{"type":"boolean"},"PackageName":{"type":"string"},"IsPackageRestricted":{"type":"boolean"},"SubscriptionExpired":{"type":"boolean"},"IntegrationsSettings":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Authentication.IntegrationsSettings"},"HasTemporaryPassword":{"type":"boolean"},"Disabled":{"type":"boolean"},"CompanyUserFullName":{"type":"string"},"EmailId":{"type":"string"},"PartnerCompanyUserId":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.DTO.Authentication.CompanyIdAuthenticationResponse":{"type":"object","properties":{"TenantId":{"format":"int32","type":"integer"},"SessionToken":{"type":"string"},"UserName":{"type":"string"},"StartPageUrl":{"type":"string"},"SubscriptionExpiryDate":{"type":"string"},"KeepUserLoggedIn":{"type":"boolean"},"MemorableWordPositions":{"type":"string"},"IsLockedOut":{"type":"boolean"},"CompanyUserId":{"format":"int32","type":"integer"},"CompanyId":{"format":"int32","type":"integer"},"PartnerId":{"format":"int32","type":"integer"},"ConnectedUserPartnerId":{"format":"int32","type":"integer"},"ClientManagerId":{"format":"int32","type":"integer"},"PartnerBrandingOptOut":{"type":"boolean"},"PackageName":{"type":"string"},"IsPackageRestricted":{"type":"boolean"},"SubscriptionExpired":{"type":"boolean"},"IntegrationsSettings":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Authentication.IntegrationsSettings"},"HasTemporaryPassword":{"type":"boolean"},"Disabled":{"type":"boolean"},"CompanyUserFullName":{"type":"string"},"EmailId":{"type":"string"},"PartnerCompanyUserId":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.Reports.BalanceSheetReport.BalanceSheetReport":{"required":["StartDate","EndDate","FixedAssetTotal","CurrentAssetTotal","CurrentLiabilitiesTotal","CapitalAndReservesTotal","FixedAssetDisplayCreditColumn","CurrentAssetDisplayCreditColumn","CurrentLiabilitiesDisplayCreditColumn","CapitalAndReservesDisplayCreditColumn","ExcludeZeroBalance","NetWorkingCapital","NetAssets"],"type":"object","properties":{"StartDate":{"type":"string"},"EndDate":{"type":"string"},"FixedAssets":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.BalanceSheetReport.BalanceSheetItem"}},"CurrentAssets":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.BalanceSheetReport.BalanceSheetItem"}},"CurrentLiabilities":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.BalanceSheetReport.BalanceSheetItem"}},"CapitalAndReserves":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.BalanceSheetReport.BalanceSheetItem"}},"FixedAssetTotal":{"format":"double","type":"number"},"CurrentAssetTotal":{"format":"double","type":"number"},"CurrentLiabilitiesTotal":{"format":"double","type":"number"},"CapitalAndReservesTotal":{"format":"double","type":"number"},"FixedAssetDisplayCreditColumn":{"type":"boolean"},"CurrentAssetDisplayCreditColumn":{"type":"boolean"},"CurrentLiabilitiesDisplayCreditColumn":{"type":"boolean"},"CapitalAndReservesDisplayCreditColumn":{"type":"boolean"},"ExcludeZeroBalance":{"type":"boolean"},"NetWorkingCapital":{"format":"double","type":"number"},"NetAssets":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.Reports.BalanceSheetReport.BalanceSheetItem":{"required":["NominalId","NominalCode","NominalName","Debit","Credit","Amount","DrillDownType"],"type":"object","properties":{"NominalId":{"format":"int32","type":"integer"},"NominalCode":{"format":"int32","type":"integer"},"NominalName":{"type":"string"},"Debit":{"format":"double","type":"number"},"Credit":{"format":"double","type":"number"},"Amount":{"format":"double","type":"number"},"ReportBreakdown":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.ReportBreakdownItem"}},"DrillDownType":{"format":"int32","description":" 1 = Nominal,  4 = Bank,  5 = ProfitAndLossAccount","enum":[1,4,5],"type":"integer"}}},"KashFlow.Accounting.Model.Reports.ReportBreakdownItem":{"required":["NominalId","Code","Amount"],"type":"object","properties":{"NominalId":{"format":"int32","type":"integer"},"ProductId":{"format":"int32","type":"integer"},"Code":{"type":"string"},"Name":{"type":"string"},"Amount":{"format":"double","type":"number"}}},"KashFlow.Accounting.DTO.BankAccount.BankAccountListResponse":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"AccountName":{"type":"string"},"Code":{"format":"int64","type":"integer"},"IsDefaultAccount":{"type":"boolean"},"TransactionLockEnabled":{"type":"boolean"},"TransactionLockDate":{"type":"string"},"ReconcileDate":{"type":"string"},"IsArchived":{"type":"boolean"},"DefaultInvoicePaymentType":{"$ref":"#/definitions/KashFlow.Accounting.DTO.BankAccount.PaymentMethodResponse"},"DefaultPurchasePaymentType":{"$ref":"#/definitions/KashFlow.Accounting.DTO.BankAccount.PaymentMethodResponse"},"FeedAccountNumber":{"type":"string"},"FeedSiteName":{"type":"string"},"FeedAccountName":{"type":"string"},"FeedAccountHolder":{"type":"string"},"FeedSource":{"type":"string"},"LastTransactionImportDate":{"type":"string"},"BankFeedsAccountId":{"format":"int32","type":"integer"},"BankBalance":{"format":"double","type":"number"},"IsBankEmpty":{"type":"boolean"},"Order":{"format":"int32","type":"integer"},"Period":{"type":"string"},"IconId":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.DTO.BankAccount.PaymentMethodResponse":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Name":{"type":"string"}}},"KashFlow.Accounting.DTO.BankAccount.BankAccountRequest":{"type":"object","properties":{"AccountName":{"type":"string"},"Code":{"format":"int64","type":"integer"},"IsDefaultAccount":{"type":"boolean"},"TransactionLockEnabled":{"type":"boolean"},"TransactionLockDate":{"type":"string"},"ReconcileDate":{"type":"string"},"StartingAmount":{"format":"double","type":"number"},"DefaultInvoicePaymentType":{"$ref":"#/definitions/KashFlow.Accounting.DTO.BankAccount.PaymentMethodBase"},"DefaultPurchasePaymentType":{"$ref":"#/definitions/KashFlow.Accounting.DTO.BankAccount.PaymentMethodBase"},"Period":{"type":"string"},"IconId":{"format":"int32","type":"integer"},"IncludeOnDashBoard":{"type":"boolean"},"Note":{"type":"string"}}},"KashFlow.Accounting.DTO.BankAccount.PaymentMethodBase":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.DTO.BankAccount.BankAccountResponse":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"AccountName":{"type":"string"},"Code":{"format":"int64","type":"integer"},"IsDefaultAccount":{"type":"boolean"},"TransactionLockEnabled":{"type":"boolean"},"TransactionLockDate":{"type":"string"},"ReconcileDate":{"type":"string"},"StartingDate":{"type":"string"},"StartingAmount":{"format":"double","type":"number"},"ShowPaidInFirst":{"type":"boolean"},"IncludeOnDashBoard":{"type":"boolean"},"Note":{"type":"string"},"OverrideTransactionLock":{"type":"boolean"},"IsArchived":{"type":"boolean"},"DefaultInvoicePaymentType":{"$ref":"#/definitions/KashFlow.Accounting.DTO.BankAccount.PaymentMethodResponse"},"DefaultPurchasePaymentType":{"$ref":"#/definitions/KashFlow.Accounting.DTO.BankAccount.PaymentMethodResponse"},"FeedAccountNumber":{"type":"string"},"FeedSiteName":{"type":"string"},"FeedAccountName":{"type":"string"},"FeedAccountHolder":{"type":"string"},"FeedSource":{"type":"string"},"LastTransactionImportDate":{"type":"string"},"BankFeedsAccountId":{"format":"int32","type":"integer"},"BankBalance":{"format":"double","type":"number"},"IsBankEmpty":{"type":"boolean"},"Order":{"format":"int32","type":"integer"},"Period":{"type":"string"},"IconId":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.RestApi.Parameters.BankAccountFilterParameters":{"type":"object","properties":{"Page":{"format":"int32","description":"Page number. (default is 1)","type":"integer"},"PerPage":{"format":"int32","description":"PerPage is number of records per page. (default is 1000)","type":"integer"},"Order":{"description":"In what order to sort the list","type":"string"},"IncludeMonthlyStats":{"description":"Flag to include/exclude bank account`s monthly statistics","type":"boolean"},"IncludeArchivedAccounts":{"description":"Flag to include/exclude archived bank accounts","type":"boolean"}}},"KashFlow.Accounting.Model.Paging[KashFlow.Accounting.DTO.BankAccount.BankAccountListResponse]":{"required":["Data"],"type":"object","properties":{"MetaData":{"$ref":"#/definitions/KashFlow.Accounting.Model.PagingMetadata"},"Data":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.BankAccount.BankAccountListResponse"}}}},"KashFlow.Accounting.DTO.BankAccount.BankAccountUpdateRequest":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"AccountName":{"type":"string"},"Code":{"format":"int64","type":"integer"},"IsDefaultAccount":{"type":"boolean"},"TransactionLockEnabled":{"type":"boolean"},"TransactionLockDate":{"type":"string"},"ReconcileDate":{"type":"string"},"IsArchived":{"type":"boolean"},"StartingDate":{"type":"string"},"StartingAmount":{"format":"double","type":"number"},"DefaultInvoicePaymentType":{"$ref":"#/definitions/KashFlow.Accounting.DTO.BankAccount.PaymentMethodBase"},"DefaultPurchasePaymentType":{"$ref":"#/definitions/KashFlow.Accounting.DTO.BankAccount.PaymentMethodBase"},"LastTransactionImportDate":{"type":"string"},"ShowPaidInFirst":{"type":"boolean"},"IncludeOnDashBoard":{"type":"boolean"},"Note":{"type":"string"},"IsImported":{"type":"boolean"},"Period":{"type":"string"},"IconId":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.BankAccountListRequest":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Order":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.BankFeed.BankFeedTransaction":{"type":"object","properties":{"BFSTransactionId":{"format":"int64","type":"integer"},"Number":{"format":"int64","type":"integer"},"Id":{"format":"int64","type":"integer"},"TransactionType":{"type":"string"},"Reference":{"type":"string"},"CustomerOrSupplierCode":{"type":"string"},"IsCredit":{"type":"string"},"IsTaxable":{"type":"boolean"},"Amount":{"format":"double","type":"number"},"CurrencyCode":{"type":"string"},"Description":{"type":"string"},"TransactionDate":{"type":"string"},"BatchId":{"type":"string"}}},"KashFlow.Accounting.DTO.BankReconciliation.BankReconciliationDetails":{"type":"object","properties":{"NextReconciliationStartBalance":{"format":"double","type":"number"},"InProgressReconciliationId":{"format":"int32","type":"integer"},"NextReconciliationStartDate":{"type":"string"}}},"KashFlow.Accounting.Model.Paging[KashFlow.Accounting.DTO.BankReconciliation.BankReconciliationResponse]":{"required":["Data"],"type":"object","properties":{"MetaData":{"$ref":"#/definitions/KashFlow.Accounting.Model.PagingMetadata"},"Data":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.BankReconciliation.BankReconciliationResponse"}}}},"KashFlow.Accounting.DTO.BankReconciliation.BankReconciliationResponse":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"EndDate":{"type":"string"},"EndBalance":{"format":"double","type":"number"},"Status":{"type":"string"},"StartDate":{"type":"string"},"StartBalance":{"format":"double","type":"number"},"LatestReconciliation":{"type":"boolean"},"ReconciliationDone":{"type":"boolean"}}},"KashFlow.Accounting.DTO.Base.BankReconciliationBase":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"EndDate":{"type":"string"},"EndBalance":{"format":"double","type":"number"},"ReconciliationDone":{"type":"boolean"}}},"KashFlow.Accounting.DTO.BankReconciliation.BankReconciliationDetailedResponse":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"EndDate":{"type":"string"},"EndBalance":{"format":"double","type":"number"},"StartDate":{"type":"string"},"StartBalance":{"format":"double","type":"number"},"LatestReconciliation":{"type":"boolean"},"AccountName":{"type":"string"},"Transactions":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.BankReconciliation.BankTransaction"}},"ReconciliationDone":{"type":"boolean"}}},"KashFlow.Accounting.DTO.BankReconciliation.BankTransaction":{"type":"object","properties":{"Id":{"format":"int64","type":"integer"},"Date":{"type":"string"},"Comment":{"type":"string"},"Type":{"type":"string"},"Reconciled":{"type":"boolean"},"Payee":{"type":"string"},"ReconciledId":{"format":"int32","type":"integer"},"PaidIn":{"format":"double","type":"number"},"PaidOut":{"format":"double","type":"number"},"EditLink":{"type":"string"},"TransactionType":{"format":"int32","description":" 0 = BankTransaction,  1 = InvoicePayment,  2 = PurchasePayment,  3 = BatchInvoice,  4 = BatchPurchase,  5 = Journal,  6 = BankReferencingAnotherBank,  -1 = Unknown","enum":[0,1,2,3,4,5,6,-1],"type":"integer"},"PaymentType":{"format":"int32","type":"integer"},"Balance":{"format":"double","type":"number"},"IsSystemGeneratedTransaction":{"type":"boolean"},"ResourceNumber":{"format":"int32","type":"integer"},"EntityName":{"type":"string"}}},"KashFlow.Accounting.DTO.BankReconciliation.BankReconciliationRequest":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"EndDate":{"type":"string"},"EndBalance":{"format":"double","type":"number"},"Status":{"type":"string"},"ReconciliationDone":{"type":"boolean"}}},"KashFlow.Accounting.DTO.BankReconciliation.ReconcilationItemsRequest":{"type":"object","properties":{"Reconcile":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.BankReconciliation.BankReconciliationTransaction"}},"UnReconcile":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.BankReconciliation.BankReconciliationTransaction"}}}},"KashFlow.Accounting.DTO.BankReconciliation.BankReconciliationTransaction":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Type":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.BankReconciliationTransaction":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Type":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.RestApi.Parameters.BankTransactionFilterParameters":{"type":"object","properties":{"Page":{"format":"int32","description":"Page number. (default is 1)","type":"integer"},"PerPage":{"format":"int32","description":"PerPage is number of records per page. (default is 10)","type":"integer"},"StartDate":{"description":"Optional. If set, only transactions with date starting from this day will be returned","type":"string"},"EndDate":{"description":"Optional. If set, only transactions with date before on this day will be returned","type":"string"},"SortColumn":{"format":"int32","description":"By what to sort the list 1 = Date,  2 = PaidIn,  3 = PaidOut,  4 = TransactionType,  5 = Comment,  6 = Name","enum":[1,2,3,4,5,6],"type":"integer"},"Order":{"description":"In what order to sort the list","type":"string"},"Filterby":{"description":"Status Filter","type":"string"},"IncludeBulk":{"description":"Whether to include bulk","type":"boolean"},"SearchText":{"description":"Filter by text","type":"string"},"IncludeFeedMatched":{"description":"Whether to include matched feed","type":"boolean"},"IncludeJournals":{"description":"&gt;Whether to include journal","type":"boolean"},"IncludeNominalCodeBankTransactions":{"description":"Whether to include Bank transactions of money type","type":"boolean"},"Reconciled":{"description":"Whether to return reconciled or unreconciled transactions. Passing null disabled this filter","type":"boolean"},"IsCSV":{"type":"boolean"}}},"KashFlow.Accounting.Model.Paging[KashFlow.Accounting.DTO.BankTransaction.BankTransactionListResponse,KashFlow.Accounting.Model.BankTransactionPagingMetadata]":{"required":["Data"],"type":"object","properties":{"MetaData":{"$ref":"#/definitions/KashFlow.Accounting.Model.BankTransactionPagingMetadata"},"Data":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.BankTransaction.BankTransactionListResponse"}}}},"KashFlow.Accounting.Model.BankTransactionPagingMetadata":{"type":"object","properties":{"OpeningBalance":{"format":"double","type":"number"},"ClosingBalance":{"format":"double","type":"number"},"TotalRecords":{"format":"int32","type":"integer"},"FirstPageUrl":{"type":"string"},"LastPageUrl":{"type":"string"},"PreviousPageUrl":{"type":"string"},"NextPageUrl":{"type":"string"},"TotalAmount":{"format":"double","type":"number"},"InvoiceLimitReached":{"type":"boolean"}}},"KashFlow.Accounting.DTO.BankTransaction.BankTransactionListResponse":{"type":"object","properties":{"Id":{"format":"int64","type":"integer"},"Date":{"type":"string"},"MoneyType":{"format":"int32","type":"integer"},"Comment":{"type":"string"},"VATAble":{"type":"boolean"},"VATAmount":{"format":"double","type":"number"},"VATRate":{"format":"double","type":"number"},"AccountId":{"format":"int32","type":"integer"},"ProjectNumber":{"format":"int32","type":"integer"},"PaidIn":{"format":"double","type":"number"},"PaidOut":{"format":"double","type":"number"},"VATPaid":{"format":"double","type":"number"},"EditLink":{"type":"string"},"ResourceNumber":{"format":"int32","type":"integer"},"LineProjectsCount":{"format":"int32","type":"integer"},"ProjectUrl":{"type":"string"},"Balance":{"format":"double","type":"number"},"EntityName":{"type":"string"},"CustomerSupplierName":{"type":"string"},"VATReturnId":{"format":"int64","type":"integer"},"Type":{"type":"string"},"Reconciled":{"type":"boolean"},"ReconciledId":{"format":"int32","type":"integer"},"ProjectName":{"type":"string"},"TransactionNumber":{"format":"int32","type":"integer"},"CustomerName":{"type":"string"},"SupplierName":{"type":"string"},"IsSystemGeneratedTransaction":{"type":"boolean"},"DisableDisallowed":{"type":"boolean"},"BFSTransactionId":{"format":"int64","type":"integer"},"CustomerCode":{"type":"string"},"SupplierCode":{"type":"string"},"TransactionType":{"format":"int32","description":" 0 = BankTransaction,  1 = InvoicePayment,  2 = PurchasePayment,  3 = BatchInvoice,  4 = BatchPurchase,  5 = Journal,  6 = BankReferencingAnotherBank,  -1 = Unknown","enum":[0,1,2,3,4,5,6,-1],"type":"integer"},"Disallowed":{"type":"boolean"},"PaymentId":{"format":"int64","type":"integer"}}},"KashFlow.Accounting.DTO.BankTransaction.BankTransactionRequest":{"type":"object","properties":{"Id":{"format":"int64","type":"integer"},"Date":{"type":"string"},"MoneyType":{"format":"int32","type":"integer"},"Comment":{"type":"string"},"VATAble":{"type":"boolean"},"VATAmount":{"format":"double","type":"number"},"VATRate":{"format":"double","type":"number"},"AccountId":{"format":"int32","type":"integer"},"ProjectNumber":{"format":"int32","type":"integer"},"PaidIn":{"format":"double","type":"number"},"PaidOut":{"format":"double","type":"number"},"VATPaid":{"format":"double","type":"number"},"BFSTransactionId":{"format":"int64","type":"integer"},"CustomerCode":{"type":"string"},"SupplierCode":{"type":"string"},"TransactionType":{"format":"int32","description":" 0 = BankTransaction,  1 = InvoicePayment,  2 = PurchasePayment,  3 = BatchInvoice,  4 = BatchPurchase,  5 = Journal,  6 = BankReferencingAnotherBank,  -1 = Unknown","enum":[0,1,2,3,4,5,6,-1],"type":"integer"},"Disallowed":{"type":"boolean"},"PaymentId":{"format":"int64","type":"integer"}}},"KashFlow.Accounting.DTO.BankTransaction.BankTransactionDetailedResponse":{"type":"object","properties":{"Id":{"format":"int64","type":"integer"},"Date":{"type":"string"},"MoneyType":{"format":"int32","type":"integer"},"Comment":{"type":"string"},"VATAble":{"type":"boolean"},"VATAmount":{"format":"double","type":"number"},"VATRate":{"format":"double","type":"number"},"AccountId":{"format":"int32","type":"integer"},"ProjectNumber":{"format":"int32","type":"integer"},"PaidIn":{"format":"double","type":"number"},"PaidOut":{"format":"double","type":"number"},"VATReturnId":{"format":"int64","type":"integer"},"Type":{"type":"string"},"Reconciled":{"type":"boolean"},"ReconciledId":{"format":"int32","type":"integer"},"ProjectName":{"type":"string"},"TransactionNumber":{"format":"int32","type":"integer"},"CustomerName":{"type":"string"},"SupplierName":{"type":"string"},"IsSystemGeneratedTransaction":{"type":"boolean"},"DisableDisallowed":{"type":"boolean"},"BFSTransactionId":{"format":"int64","type":"integer"},"CustomerCode":{"type":"string"},"SupplierCode":{"type":"string"},"TransactionType":{"format":"int32","description":" 0 = BankTransaction,  1 = InvoicePayment,  2 = PurchasePayment,  3 = BatchInvoice,  4 = BatchPurchase,  5 = Journal,  6 = BankReferencingAnotherBank,  -1 = Unknown","enum":[0,1,2,3,4,5,6,-1],"type":"integer"},"Disallowed":{"type":"boolean"},"PaymentId":{"format":"int64","type":"integer"}}},"KashFlow.Accounting.DTO.BankTransaction.BankTransactionDetailRequest":{"type":"object","properties":{"Id":{"format":"int64","type":"integer"},"Date":{"type":"string"},"MoneyType":{"format":"int32","type":"integer"},"Comment":{"type":"string"},"VATAble":{"type":"boolean"},"VATAmount":{"format":"double","type":"number"},"VATRate":{"format":"double","type":"number"},"AccountId":{"format":"int32","type":"integer"},"ProjectNumber":{"format":"int32","type":"integer"},"PaidIn":{"format":"double","type":"number"},"PaidOut":{"format":"double","type":"number"},"BFSTransactionId2":{"format":"int64","type":"integer"},"VATPaid":{"format":"double","type":"number"},"BFSTransactionId":{"format":"int64","type":"integer"},"CustomerCode":{"type":"string"},"SupplierCode":{"type":"string"},"TransactionType":{"format":"int32","description":" 0 = BankTransaction,  1 = InvoicePayment,  2 = PurchasePayment,  3 = BatchInvoice,  4 = BatchPurchase,  5 = Journal,  6 = BankReferencingAnotherBank,  -1 = Unknown","enum":[0,1,2,3,4,5,6,-1],"type":"integer"},"Disallowed":{"type":"boolean"},"PaymentId":{"format":"int64","type":"integer"}}},"KashFlow.Accounting.DTO.BankTransaction.BankTransactionBulkAssignRequest":{"type":"object","properties":{"AssignToInvoices":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.BankTransaction.AssigntoEntity"}},"AssignToPurchases":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.BankTransaction.AssigntoEntity"}}}},"KashFlow.Accounting.DTO.BankTransaction.AssigntoEntity":{"type":"object","properties":{"TransactionId":{"format":"int32","type":"integer"},"PaymentMethod":{"format":"int32","type":"integer"},"Number":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.BankTransactionBulkAssign":{"type":"object","properties":{"AssignToInvoices":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.AssigntoEntity"}},"AssignToPurchases":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.AssigntoEntity"}},"FailedTransactions":{"$ref":"#/definitions/KashFlow.Accounting.Model.BankTransactionBulkAssignStatus"}}},"KashFlow.Accounting.Model.AssigntoEntity":{"type":"object","properties":{"TransactionId":{"format":"int32","type":"integer"},"PaymentMethod":{"format":"int32","type":"integer"},"Number":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.BankTransactionBulkAssignStatus":{"type":"object","properties":{"AssignToInvoices":{"type":"array","items":{"format":"int32","type":"integer"}},"AssignToPurchases":{"type":"array","items":{"format":"int32","type":"integer"}}}},"KashFlow.Accounting.Model.Base.BankTransactionMassDeleteStatus":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Reason":{"type":"string"}}},"KashFlow.Accounting.Model.Bank.CreateToEntityWrapper":{"type":"object","properties":{"CreateEntityRequest":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Bank.CreateToEntity"}},"EntityType":{"format":"int32","description":" 1 = Invoice,  2 = Purchase,  3 = RecurringInvoice,  4 = RecurringPurchase,  5 = Quote,  6 = PurchaseOrder","enum":[1,2,3,4,5,6],"type":"integer"}}},"KashFlow.Accounting.Model.Bank.CreateToEntity":{"type":"object","properties":{"TransactionId":{"format":"int32","type":"integer"},"PaymentMethod":{"format":"int32","type":"integer"},"EntityCode":{"type":"string"}}},"KashFlow.Accounting.Model.Bank.EntityMassCreateStatus":{"type":"object","properties":{"BankTransactionId":{"format":"int64","type":"integer"},"Message":{"type":"string"}}},"KashFlow.Accounting.DTO.BankTransaction.BankFeedTransactionResponse":{"type":"object","properties":{"BFSTransactionId":{"format":"int64","type":"integer"},"Number":{"format":"int64","type":"integer"},"TransactionType":{"type":"string"},"Reference":{"type":"string"},"CustomerOrSupplierCode":{"type":"string"},"IsCredit":{"type":"string"},"Amount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.BrandingSettings":{"type":"object","properties":{"IsBrandingApplicable":{"type":"boolean"},"ApplicationName":{"type":"string"},"PrimaryButton":{"type":"string"},"PrimaryColour":{"type":"string"},"ReportsPrimaryColour":{"type":"string"},"SecondaryButton":{"type":"string"},"SecondaryColour":{"type":"string"},"SideMenu":{"type":"string"},"TopNavigation":{"type":"string"}}},"KashFlow.Accounting.Model.Payment.BulkPayment":{"type":"object","properties":{"Number":{"format":"int32","type":"integer"},"Date":{"type":"string"},"Comment":{"type":"string"},"AccountId":{"format":"int32","type":"integer"},"Method":{"format":"int32","type":"integer"},"Reconciled":{"type":"boolean"},"BankReconciliationId":{"format":"int32","type":"integer"},"resetBankReconciliation":{"type":"boolean"},"PaymentItems":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Payment.BulkPaymentItem"}},"ExportDetails":{"$ref":"#/definitions/KashFlow.Accounting.Model.Payment.ExportDetails"},"BFSTransactionId":{"format":"int64","type":"integer"},"DoesCustomersHaveEmail":{"type":"boolean"},"DoesSuppliersHaveEmail":{"type":"boolean"}}},"KashFlow.Accounting.Model.Payment.BulkPaymentItem":{"type":"object","properties":{"Id":{"format":"int64","type":"integer"},"Amount":{"format":"double","type":"number"},"PaidDate":{"type":"string"},"ObjectNumber":{"format":"int32","type":"integer"},"ContactName":{"type":"string"},"ContactCode":{"type":"string"},"ContactId":{"format":"int32","type":"integer"},"ContactReference":{"type":"string"},"ObjectIssuedDate":{"type":"string"},"VATReturnId":{"format":"int64","type":"integer"},"EmailAddress":{"type":"string"},"ObjectDueDate":{"type":"string"},"resetBankReconciliation":{"type":"boolean"}}},"KashFlow.Accounting.Model.Payment.ExportDetails":{"type":"object","properties":{"Permalink":{"type":"string"},"ContactCode":{"type":"string"},"ObjectNumber":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.Reports.ActivityReport.ActivityReportRequest":{"required":["StartDate","EndDate"],"type":"object","properties":{"IncludeTransactions":{"format":"int32","description":" 0 = SalesPurchases,  1 = Sales,  2 = Purchases","enum":[0,1,2],"type":"integer"},"BasedOn":{"format":"int32","description":" 0 = All,  1 = PaidOnly","enum":[0,1],"type":"integer"},"ShowVATRelatedInformation":{"type":"boolean"},"ShowFullCustomerSupplierName":{"type":"boolean"},"SortBy":{"format":"int32","description":" 0 = PaidDate,  1 = Date,  2 = Number,  3 = Reference,  4 = Code,  5 = Name,  6 = Nominal,  7 = Note,  8 = MoneyIn,  9 = MoneyOut,  10 = InputVat,  11 = OutputVat","enum":[0,1,2,3,4,5,6,7,8,9,10,11],"type":"integer"},"OrderBy":{"type":"string"},"PageNumber":{"format":"int32","type":"integer"},"PerPage":{"format":"int32","type":"integer"},"StartDate":{"type":"string"},"EndDate":{"type":"string"}}},"KashFlow.Accounting.Model.Reports.ActivityReport.ActivityReportResponse":{"type":"object","properties":{"Date":{"type":"string"},"PaidDate":{"type":"string"},"EntityType":{"type":"string"},"Ref":{"type":"string"},"InputVat":{"format":"double","type":"number"},"OutputVat":{"format":"double","type":"number"},"Note":{"type":"string"},"Type":{"type":"string"},"MoneyIn":{"format":"double","type":"number"},"MoneyOut":{"format":"double","type":"number"},"CustomerSupplier":{"type":"string"},"PurchaseOrSupplierReference":{"type":"string"}}},"KashFlow.Accounting.Model.Reports.AuditReport.AuditReportRequest":{"required":["StartDate","EndDate"],"type":"object","properties":{"TransactionBasedOn":{"format":"int32","description":" 0 = SpecificTransaction,  1 = TransactionBetweenDates,  2 = TransactionCreatedOrEditedOrDeletedBetweenDates","enum":[0,1,2],"type":"integer"},"TransactionNumber":{"format":"int32","type":"integer"},"IncludeSalesInvoices":{"type":"boolean"},"IncludeSalesInvoicePayments":{"type":"boolean"},"IncludePurchaseInvoices":{"type":"boolean"},"IncludePurchaseInvoicePayments":{"type":"boolean"},"IncludeBankTransactions":{"type":"boolean"},"IncludeJournal":{"type":"boolean"},"IncludeDeletedItems":{"type":"boolean"},"UserName":{"type":"string"},"Created":{"type":"boolean"},"Page":{"format":"int32","type":"integer"},"PerPage":{"format":"int32","type":"integer"},"Order":{"type":"string"},"SortBy":{"format":"int32","description":" 0 = CreatedDate,  1 = Date,  2 = TransactionNumber,  3 = Type,  4 = Reference,  5 = Value,  6 = Narrative,  7 = TaxRate,  8 = InputTax,  9 = OutputTax,  10 = NominalCode,  11 = Changes,  12 = UserName,  13 = EntityNumber","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,13],"type":"integer"},"StartDate":{"type":"string"},"EndDate":{"type":"string"}}},"KashFlow.Accounting.Model.Paging[KashFlow.Accounting.Model.Reports.AuditReport.AuditReportResponse]":{"required":["Data"],"type":"object","properties":{"MetaData":{"$ref":"#/definitions/KashFlow.Accounting.Model.PagingMetadata"},"Data":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.AuditReport.AuditReportResponse"}}}},"KashFlow.Accounting.Model.Reports.AuditReport.AuditReportResponse":{"type":"object","properties":{"CreatedDate":{"format":"date-time","type":"string"},"TransactionNumber":{"format":"int32","type":"integer"},"TransactionType":{"type":"string"},"Date":{"format":"date-time","type":"string"},"Reference":{"type":"string"},"Value":{"format":"double","type":"number"},"Narrative":{"type":"string"},"Vat":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.AuditReport.Vat"},"Nominal":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.AuditReport.Nominal"},"ChangeCount":{"format":"int32","type":"integer"},"FullName":{"type":"string"},"EntityNumber":{"format":"int32","type":"integer"},"EntityReferance":{"type":"string"},"Current":{"format":"int32","type":"integer"},"IsDeleted":{"type":"boolean"},"EntityId":{"format":"int32","type":"integer"},"BankAccountId":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.Reports.AuditReport.Vat":{"type":"object","properties":{"IsExempt":{"type":"boolean"},"Rate":{"format":"double","type":"number"},"Input":{"format":"double","type":"number"},"Output":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.Reports.AuditReport.Nominal":{"type":"object","properties":{"Code":{"format":"int32","type":"integer"},"Name":{"type":"string"}}},"KashFlow.Accounting.Model.Reports.HistoricSalesAndExpenditureReport.HistoricSalesAndExpenditureReportResponse":{"type":"object","properties":{"Code":{"format":"int32","type":"integer"},"CodeName":{"type":"string"},"Total":{"format":"double","type":"number"},"Months":{"type":"object","additionalProperties":{"format":"double","type":"number"}},"CodeType":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.Reports.StockOverviewReport.StockOverviewReportResponse":{"type":"object","properties":{"TotalValue":{"format":"double","type":"number"},"Stocks":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.StockOverviewReport.StockOverviewReport"}}}},"KashFlow.Accounting.Model.Reports.StockOverviewReport.StockOverviewReport":{"type":"object","properties":{"NominalCode":{"format":"int32","type":"integer"},"NominalName":{"type":"string"},"ProductCode":{"type":"string"},"ProductName":{"type":"string"},"ProductDescription":{"type":"string"},"ProductPrice":{"format":"double","type":"number"},"QuantityInStock":{"format":"int32","type":"integer"},"StockValue":{"format":"double","type":"number"},"PendingDelivery":{"format":"int32","type":"integer"},"AlertLevel":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.Reports.GlobalProjectReport.GlobalProjectReportResponse":{"type":"object","properties":{"Name":{"type":"string"},"Number":{"format":"int32","type":"integer"},"Reference":{"type":"string"},"Customer":{"type":"string"},"Status":{"format":"int32","type":"integer"},"TargetIncome":{"format":"double","type":"number"},"TargetExpenditure":{"format":"double","type":"number"},"ActualIncome":{"format":"double","type":"number"},"ActualExpenditure":{"format":"double","type":"number"},"Journal":{"format":"double","type":"number"},"IncomeDifference":{"format":"double","type":"number"},"ExpenditureDifference":{"format":"double","type":"number"},"ExcludingVAT":{"type":"boolean"}}},"KashFlow.Accounting.Model.Reports.BusinessReport.BusinessProgressSummaryReport.BusinessProgressSummaryRequest":{"required":["StartDate","EndDate"],"type":"object","properties":{"BasedOn":{"format":"int32","description":" 0 = Cash,  1 = Invoice","enum":[0,1],"type":"integer"},"StartDate":{"type":"string"},"EndDate":{"type":"string"}}},"KashFlow.Accounting.Model.Reports.BusinessReport.BusinessProgressSummaryReport.BusinessProgressSummaryResponse":{"type":"object","properties":{"PeriodCovered":{"type":"string"},"SalesInThisPeriod":{"format":"double","type":"number"},"ExpensesInThisPeriod":{"format":"double","type":"number"},"BalanceDate":{"type":"string"},"AgreedDateOfNextMeeting":{"type":"string"}}},"KashFlow.Accounting.Model.Reports.ReportBaseRequest":{"required":["StartDate","EndDate"],"type":"object","properties":{"StartDate":{"type":"string"},"EndDate":{"type":"string"}}},"KashFlow.Accounting.Model.Reports.BusinessReport.DigitaExportsReportResponse":{"type":"object","properties":{"PostingType":{"type":"string"},"BankAccount":{"type":"string"},"Date":{"type":"string"},"Reference":{"format":"int32","type":"integer"},"Details":{"type":"string"},"NominalCode":{"type":"string"},"CostUnit":{"format":"int32","type":"integer"},"VATCode":{"type":"string"},"DeletedTransaction":{"type":"boolean"},"Gross":{"format":"double","type":"number"},"VATAmount":{"format":"double","type":"number"},"Net":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.Reports.HSBCFactoring.HsbcFactoringRequest":{"required":["StartDate","EndDate"],"type":"object","properties":{"ClientNumber":{"type":"string"},"Password":{"type":"string"},"StartDate":{"type":"string"},"EndDate":{"type":"string"}}},"KashFlow.Accounting.Model.Reports.HSBCFactoring.HsbcFactoringResponse":{"type":"object","properties":{"Metadata":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.HSBCFactoring.HsbcMetadata"},"Invoices":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.HSBCFactoring.HsbcInvoice"}}}},"KashFlow.Accounting.Model.Reports.HSBCFactoring.HsbcMetadata":{"type":"object","properties":{"CompanyName":{"type":"string"},"AddressLine1":{"type":"string"},"AddressLine2":{"type":"string"},"AddressLine3":{"type":"string"},"AddressLine4":{"type":"string"},"PostCode":{"type":"string"},"VATNumber":{"type":"string"},"HSBCClientNumber":{"type":"string"},"HSBCPassword":{"type":"string"}}},"KashFlow.Accounting.Model.Reports.HSBCFactoring.HsbcInvoice":{"type":"object","properties":{"InvoiceId":{"format":"int32","type":"integer"},"InvoiceNumber":{"format":"int32","type":"integer"},"PaymentTerms":{"type":"string"},"InvoiceOrCredit":{"type":"string"},"InvoiceDate":{"type":"string"},"CustomerName":{"type":"string"},"HSBCCustomerNumber":{"type":"string"},"CustomerCode":{"type":"string"},"CustomerAddress1":{"type":"string"},"CustomerAddress2":{"type":"string"},"CustomerAddress3":{"type":"string"},"CustomerAddress4":{"type":"string"},"CustomerPostCode":{"type":"string"},"CurrencyCode":{"type":"string"},"CustHasDeliveryAddress":{"type":"boolean"},"CustDeliveryAdd1":{"type":"string"},"CustDeliveryAdd2":{"type":"string"},"CustDeliveryAdd3":{"type":"string"},"CustDeliveryAdd4":{"type":"string"},"CustDeliveryPostCode":{"type":"string"},"NetAmount":{"format":"double","type":"number"},"VatAmount":{"format":"double","type":"number"},"Total":{"format":"double","type":"number"},"Lineitems":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.HSBCFactoring.HsbcLineItem"}}}},"KashFlow.Accounting.Model.Reports.HSBCFactoring.HsbcLineItem":{"type":"object","properties":{"Description":{"type":"string"},"Quantity":{"format":"double","type":"number"},"Subtotal":{"format":"double","type":"number"},"VATRate":{"format":"double","type":"number"},"VatAmount":{"format":"double","type":"number"},"VatCode":{"type":"string"}}},"KashFlow.Accounting.Model.Reports.BusinessReport.PrePaymentsAccrualsRequest":{"required":["StartDate","EndDate"],"type":"object","properties":{"IsBasedOnInvoice":{"type":"boolean"},"StartDate":{"type":"string"},"EndDate":{"type":"string"}}},"KashFlow.Accounting.Model.Reports.BusinessReport.PrePaymentsAccrualsResponse":{"type":"object","properties":{"LineId":{"format":"int32","type":"integer"},"InvoiceDetails":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.BusinessReport.InvoiceDetails"},"ReceiptDetails":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.BusinessReport.ReceiptDetails"},"NominalName":{"type":"string"},"Amount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.Reports.BusinessReport.InvoiceDetails":{"type":"object","properties":{"InvoiceId":{"format":"int32","type":"integer"},"InvoiceNumber":{"format":"int32","type":"integer"},"InvoiceDate":{"type":"string"},"CustomerName":{"type":"string"},"CustomerCode":{"type":"string"}}},"KashFlow.Accounting.Model.Reports.BusinessReport.ReceiptDetails":{"type":"object","properties":{"ReceiptId":{"format":"int32","type":"integer"},"ReceiptNumber":{"format":"int32","type":"integer"},"ReceiptDate":{"type":"string"},"SupplierName":{"type":"string"},"SupplierCode":{"type":"string"}}},"KashFlow.Accounting.Model.Reports.BusinessReport.JournalsPreviewRequest":{"type":"object","properties":{"LineIds":{"type":"string"},"NominalCode":{"format":"int32","type":"integer"},"PeriodType":{"format":"int32","description":" 0 = Days,  1 = Months","enum":[0,1],"type":"integer"},"Period":{"format":"int32","type":"integer"},"StartDate":{"type":"string"},"Installments":{"format":"int32","type":"integer"},"IsReceipt":{"type":"boolean"}}},"KashFlow.Accounting.Model.Reports.BusinessReport.JournalsPreviewResponse":{"type":"object","properties":{"JournalNumber":{"format":"int32","type":"integer"},"JournalDate":{"type":"string"},"Comment":{"type":"string"},"NominalName":{"type":"string"},"NominalCode":{"format":"int32","type":"integer"},"Debit":{"format":"double","type":"number"},"Credit":{"format":"double","type":"number"},"LineId":{"format":"int32","type":"integer"},"Installment":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.Reports.BusinessReport.HealthCheckReportResponse":{"type":"object","properties":{"HealthCheckReport":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.BusinessReport.HealthCheckReport"}},"Partner":{"$ref":"#/definitions/KashFlow.Accounting.Model.Internal.Partner"}}},"KashFlow.Accounting.Model.Reports.BusinessReport.HealthCheckReport":{"type":"object","properties":{"Number":{"format":"int32","type":"integer"},"Title":{"type":"string"},"Information":{"type":"string"},"Score":{"format":"int32","type":"integer"},"PossibleScore":{"format":"int32","type":"integer"},"ResultText":{"type":"string"},"Improvetext":{"type":"string"},"TotalScore":{"format":"int32","type":"integer"},"TotalPossibleScore":{"format":"int32","type":"integer"},"Percentage":{"format":"int32","type":"integer"},"TotalPercentage":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.Internal.Partner":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Name":{"type":"string"},"CompanyName":{"type":"string"},"Email":{"type":"string"},"Password":{"type":"string"},"Address":{"$ref":"#/definitions/KashFlow.Core.Model.Address"},"Telephone":{"type":"string"},"Ref":{"type":"string"},"SubscriptionStart":{"format":"date-time","type":"string"},"SubscriptionEnd":{"format":"date-time","type":"string"},"PromoCode":{"type":"string"},"CreatedBy":{"type":"string"},"PIVACERef":{"type":"string"},"SalesAgentId":{"format":"int32","type":"integer"},"Credits":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Internal.PartnerCredits.PartnerCredit"}},"UsingOldModel":{"type":"boolean"},"ManagedBy":{"type":"string"},"KashFlowCustomerId":{"format":"int32","type":"integer"}}},"KashFlow.Core.Model.Address":{"type":"object","properties":{"Line1":{"type":"string"},"Line2":{"type":"string"},"Line3":{"type":"string"},"Line4":{"type":"string"},"PostCode":{"type":"string"},"CountryName":{"type":"string"},"CountryCode":{"type":"string"},"CountryId":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.Internal.PartnerCredits.PartnerCredit":{"type":"object","properties":{"ID":{"format":"int32","type":"integer"},"SubscriptionType":{"type":"string"},"CreditType":{"format":"int32","description":" 0 = Legacy,  1 = Starter,  2 = Business,  3 = BP","enum":[0,1,2,3],"type":"integer"},"CreatedDate":{"format":"date-time","type":"string"},"StartDate":{"format":"date-time","type":"string"},"EndDate":{"format":"date-time","type":"string"},"SalesAgentId":{"format":"int32","type":"integer"},"PartnerId":{"format":"int32","type":"integer"},"PurchaseMethod":{"format":"int32","description":" 0 = Direct,  1 = SalesAgent","enum":[0,1],"type":"integer"},"Usages":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Internal.PartnerCredits.Usage"}},"Renewable":{"type":"boolean"}}},"KashFlow.Accounting.Model.Internal.PartnerCredits.Usage":{"type":"object","properties":{"ID":{"format":"int32","type":"integer"},"UsageType":{"format":"int32","description":" 0 = Consumed,  1 = Expired,  2 = Refunded","enum":[0,1,2],"type":"integer"},"UsageDate":{"format":"date-time","type":"string"},"ClientId":{"format":"int32","type":"integer"},"ClientName":{"type":"string"},"ClientFirstOnboardingDate":{"format":"date-time","type":"string"}}},"KashFlow.Accounting.Model.Reports.BusinessReport.CISSummary.CisSummaryRequest":{"required":["StartDate","EndDate"],"type":"object","properties":{"Entity":{"format":"int32","description":" 0 = Sales,  1 = Purchases","enum":[0,1],"type":"integer"},"BasedOn":{"format":"int32","description":" 0 = All,  1 = PaidOnly","enum":[0,1],"type":"integer"},"CustomerCode":{"type":"string"},"SupplierCode":{"type":"string"},"StartDate":{"type":"string"},"EndDate":{"type":"string"}}},"KashFlow.Accounting.Model.Reports.BusinessReport.CISSummary.CisSummaryResponse":{"type":"object","properties":{"Metadata":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.BusinessReport.CISSummary.CisMetadata"},"CisSummary":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.BusinessReport.CISSummary.CisSummaryBase"}}}},"KashFlow.Accounting.Model.Reports.BusinessReport.CISSummary.CisMetadata":{"type":"object","properties":{"TotalAmount":{"format":"double","type":"number"},"TotalExclusions":{"format":"double","type":"number"},"TotalCisDeduction":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.Reports.BusinessReport.CISSummary.CisSummaryBase":{"type":"object","properties":{"ReferenceField1":{"type":"string"},"ReferenceField2":{"type":"string"},"ReferenceField3":{"type":"string"},"ReferenceField4":{"type":"string"},"ReferenceField5":{"type":"string"},"TotalAmount":{"format":"double","type":"number"},"TotalExclusions":{"format":"double","type":"number"},"TotalCisDeduction":{"format":"double","type":"number"},"CisItems":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.BusinessReport.CISSummary.CisItem"}}}},"KashFlow.Accounting.Model.Reports.BusinessReport.CISSummary.CisItem":{"type":"object","properties":{"Number":{"format":"int32","type":"integer"},"IssueDate":{"type":"string"},"PaidDate":{"type":"string"},"NominalNames":{"type":"string"},"Amount":{"format":"double","type":"number"},"Exclusions":{"format":"double","type":"number"},"CisDeduction":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.Reports.SageExport.SageEntityCount":{"type":"object","properties":{"CustomerCount":{"format":"int32","type":"integer"},"SupplierCount":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.Reports.BusinessReport.AuditTrailTransactionRequest":{"required":["StartDate","EndDate"],"type":"object","properties":{"IncludePayments":{"type":"boolean"},"StartDate":{"type":"string"},"EndDate":{"type":"string"}}},"KashFlow.Accounting.Model.Reports.BusinessReport.AuditTrailTransactionResponse":{"type":"object","properties":{"EntityType":{"type":"string"},"Number":{"type":"string"},"EntityDate":{"type":"string"},"EntityCode":{"type":"string"},"NominalCode":{"format":"int32","type":"integer"},"Description":{"type":"string"},"Total":{"format":"double","type":"number"},"VatCode":{"type":"string"},"VatAmount":{"format":"double","type":"number"},"Dept":{"type":"string"},"ExchangeRate":{"format":"int32","type":"integer"},"ExtraRef":{"type":"string"},"Username":{"type":"string"}}},"KashFlow.Accounting.Model.CustomerSourceList":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"NumberOfCustomer":{"format":"int32","type":"integer"},"PaymentReceivedIncVAT":{"format":"double","type":"number"},"TotalInvoicesIssuedExcVAT":{"format":"double","type":"number"},"Name":{"type":"string"},"CostOfSource":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.CustomerSourceDetail":{"type":"object","properties":{"CustomerList":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.SourceCustomerList"}},"Id":{"format":"int32","type":"integer"},"NumberOfCustomer":{"format":"int32","type":"integer"},"PaymentReceivedIncVAT":{"format":"double","type":"number"},"TotalInvoicesIssuedExcVAT":{"format":"double","type":"number"},"Name":{"type":"string"},"CostOfSource":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.SourceCustomerList":{"type":"object","properties":{"CustomerId":{"format":"int32","type":"integer"},"CustomerName":{"type":"string"}}},"KashFlow.Accounting.Model.CustomerSourceBase":{"type":"object","properties":{"Name":{"type":"string"},"CostOfSource":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.Payment.CardlessPaymentDetails":{"type":"object","properties":{"InvoiceNumber":{"format":"int32","type":"integer"},"Amount":{"format":"double","type":"number"}}},"KashFlow.Accounting.DTO.Response.CardlessPaymentDetailResponse":{"type":"object","properties":{"Message":{"type":"string"},"AuthorizationCode":{"type":"string"}}},"KashFlow.Accounting.Model.Payment.PaymentDetails":{"type":"object","properties":{"CardHolderName":{"type":"string"},"PCICardToken":{"type":"string"},"Token3DSecure":{"type":"string"},"AddressLine1":{"type":"string"},"AddressLine2":{"type":"string"},"AddressLine3":{"type":"string"},"AddressLine4":{"type":"string"},"AddressLine5":{"type":"string"},"PostalCode":{"type":"string"},"CardType":{"type":"string"},"CardNumber":{"type":"string"},"CVVNumber":{"format":"int32","type":"integer"},"ExpiryMonth":{"format":"int32","type":"integer"},"ExpiryYear":{"format":"int32","type":"integer"},"StartMonth":{"format":"int32","type":"integer"},"StartYear":{"format":"int32","type":"integer"},"IssueNumber":{"type":"string"},"CustomerCode":{"type":"string"},"InvoiceNumber":{"format":"int32","type":"integer"},"Amount":{"format":"double","type":"number"},"IPAddress":{"type":"string"},"PartnerId":{"format":"int32","type":"integer"},"RecurringReference":{"type":"string"},"IridiumPaRES":{"type":"string"},"PaymentDescription":{"type":"string"},"OrderId":{"type":"string"},"IsManualPayment":{"type":"boolean"},"PaymentType":{"format":"int32","description":" 1 = Moto,  2 = eCommerce","enum":[1,2],"type":"integer"},"ProviderOrderId":{"type":"string"},"IridiumCRES":{"type":"string"},"ThreeDSMethodData":{"type":"string"},"ScreenHeight":{"format":"int32","type":"integer"},"ScreenWidth":{"format":"int32","type":"integer"},"TimeZone":{"format":"int32","type":"integer"},"ReCaptchaToken":{"type":"string"}}},"KashFlow.Accounting.Model.Payment.CardPaymentResponse":{"type":"object","properties":{"Message":{"type":"string"},"AuthorizationCode":{"type":"string"},"Reference":{"type":"string"},"FormattedDueAmount":{"type":"string"}}},"KashFlow.Accounting.Model.Payment.RefundRequest":{"type":"object","properties":{"TransactionId":{"type":"string"},"Amount":{"format":"double","type":"number"},"Reason":{"type":"string"},"CardPaymentId":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.DTO.Wrapper.CategoryWrapper":{"required":["EntityType"],"type":"object","properties":{"CategoriesList":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.CategoryRequest"}},"EntityType":{"type":"string"}}},"KashFlow.Accounting.Model.CategoryRequest":{"required":["Number","Name","IconId"],"type":"object","properties":{"Number":{"format":"int32","type":"integer"},"Name":{"type":"string"},"IconId":{"format":"int32","type":"integer"},"IconType":{"type":"string"},"IconColor":{"type":"string"}}},"KashFlow.Accounting.Model.CategoryIcon":{"required":["Id","Name","Path","Type","Color"],"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Name":{"type":"string"},"Path":{"type":"string"},"Type":{"type":"string"},"Color":{"type":"string"}}},"KashFlow.Accounting.DTO.CompanyDetails.CompanyDetailsResponse":{"type":"object","properties":{"Username":{"type":"string"},"Contact":{"$ref":"#/definitions/KashFlow.Accounting.DTO.CompanyDetails.CompanyContact"},"PaymentTerms":{"$ref":"#/definitions/KashFlow.Accounting.DTO.PaymentTerms"},"BusinessType":{"format":"int32","description":" 0 = NotSet,  1 = Limited,  2 = SoleTrader,  3 = Partnership,  4 = GeneralPractitioner,  20 = Other","enum":[0,1,2,3,4,20],"type":"integer"},"IndustrySector":{"$ref":"#/definitions/KashFlow.Accounting.DTO.CompanyDetails.IndustrySector"},"BetaParticipation":{"type":"boolean"},"EmployeeCountRangeId":{"format":"byte","type":"string"},"SubscriptionStatus":{"format":"int32","description":" 0 = Active,  1 = Cancelled,  2 = Expired","enum":[0,1,2],"type":"integer"},"VatRegisteredState":{"format":"int32","type":"integer"},"IsVatNumberReadOnly":{"type":"boolean"},"IsDemoAccount":{"type":"boolean"},"SubscriptionType":{"type":"string"},"AppleProductId":{"type":"string"},"Application":{"format":"int32","description":" 1 = RsrApp,  2 = OldWebApp,  3 = MobileIOS","enum":[1,2,3],"type":"integer"},"AccountingType":{"format":"int32","description":" 0 = Cash,  1 = Accrual","enum":[0,1],"type":"integer"},"CompanyName":{"type":"string"},"HomeCurrency":{"$ref":"#/definitions/KashFlow.Accounting.DTO.CompanyDetails.Currency"},"DateFormat":{"type":"string"},"VATRegistered":{"type":"boolean"},"VatRegisteredIn":{"type":"string"},"VATNumber":{"type":"string"},"Address":{"$ref":"#/definitions/KashFlow.Accounting.DTO.CompanyDetails.Address"},"ShowRebrandUI":{"type":"boolean"}}},"KashFlow.Accounting.DTO.CompanyDetails.CompanyContact":{"type":"object","properties":{"Name":{"type":"string"},"Telephone":{"type":"string"},"Mobile":{"type":"string"},"Email":{"type":"string"}}},"KashFlow.Accounting.DTO.PaymentTerms":{"required":["Type","Days"],"type":"object","properties":{"Type":{"type":"string"},"Days":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.DTO.CompanyDetails.IndustrySector":{"type":"object","properties":{"TopLevel":{"$ref":"#/definitions/KashFlow.Accounting.DTO.CompanyDetails.IndustrySectorDetailsBase"},"MiddleLevel":{"$ref":"#/definitions/KashFlow.Accounting.DTO.CompanyDetails.IndustrySectorDetailsBase"},"BottomLevel":{"$ref":"#/definitions/KashFlow.Accounting.DTO.CompanyDetails.IndustrySectorDetailsBase"}}},"KashFlow.Accounting.DTO.CompanyDetails.Currency":{"required":["Code"],"type":"object","properties":{"Name":{"type":"string"},"Symbol":{"type":"string"},"DisplaySymbolOnRight":{"type":"boolean"},"Code":{"type":"string"},"ExchangeRate":{"format":"double","type":"number"}}},"KashFlow.Accounting.DTO.CompanyDetails.Address":{"type":"object","properties":{"CountryName":{"type":"string"},"CountryCode":{"type":"string"},"Line1":{"type":"string"},"Line2":{"type":"string"},"Line3":{"type":"string"},"Line4":{"type":"string"},"PostCode":{"type":"string"}}},"KashFlow.Accounting.DTO.CompanyDetails.IndustrySectorDetailsBase":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Name":{"type":"string"}}},"KashFlow.Accounting.DTO.CompanyDetails.CompanyDetailsRequest":{"required":["BusinessType"],"type":"object","properties":{"Username":{"type":"string"},"Contact":{"$ref":"#/definitions/KashFlow.Accounting.DTO.CompanyDetails.CompanyContact"},"PaymentTerms":{"$ref":"#/definitions/KashFlow.Accounting.DTO.PaymentTerms"},"BusinessType":{"format":"int32","description":" 0 = NotSet,  1 = Limited,  2 = SoleTrader,  3 = Partnership,  4 = GeneralPractitioner,  20 = Other","enum":[0,1,2,3,4,20],"type":"integer"},"IndustrySector":{"$ref":"#/definitions/KashFlow.Accounting.DTO.CompanyDetails.IndustrySector"},"BetaParticipation":{"type":"boolean"},"EmployeeCountRangeId":{"format":"byte","type":"string"},"AccountingType":{"format":"int32","description":" 0 = Cash,  1 = Accrual","enum":[0,1],"type":"integer"},"CompanyName":{"type":"string"},"HomeCurrency":{"$ref":"#/definitions/KashFlow.Accounting.DTO.CompanyDetails.Currency"},"DateFormat":{"type":"string"},"VATRegistered":{"type":"boolean"},"VatRegisteredIn":{"type":"string"},"VATNumber":{"type":"string"},"Address":{"$ref":"#/definitions/KashFlow.Accounting.DTO.CompanyDetails.Address"},"ShowRebrandUI":{"type":"boolean"}}},"KashFlow.Accounting.Model.Settings.IndustrySectorList":{"type":"object","properties":{"TopLevelList":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Settings.IndustrySectorDetails"}},"MiddleLevelList":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Settings.IndustrySectorDetails"}},"BottomLevelList":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Settings.IndustrySectorDetails"}}}},"KashFlow.Accounting.Model.Settings.IndustrySectorDetails":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Name":{"type":"string"},"ParentId":{"format":"int32","type":"integer"},"ParentName":{"type":"string"}}},"KashFlow.Accounting.Model.Settings.BusinessType":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Name":{"type":"string"}}},"KashFlow.Accounting.Model.Settings.EmployeeCountRange":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Range":{"type":"string"}}},"KashFlow.Accounting.Model.Filter.CompanyHouseSearchFilter":{"required":["SearchText"],"type":"object","properties":{"SearchText":{"type":"string"},"PerPage":{"format":"int32","type":"integer"},"Page":{"format":"int32","type":"integer"},"Restrictions":{"type":"string"}}},"KashFlow.Accounting.Model.CompanyHouse.CompanyHouseDetails":{"type":"object","properties":{"page_number":{"format":"int32","type":"integer"},"items_per_page":{"format":"int32","type":"integer"},"start_index":{"format":"int32","type":"integer"},"total_results":{"format":"int32","type":"integer"},"items":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.CompanyHouse.CompanyHouse"}}}},"KashFlow.Accounting.Model.CompanyHouse.CompanyHouse":{"type":"object","properties":{"company_number":{"type":"string"},"company_status":{"type":"string"},"company_type":{"type":"string"},"date_of_creation":{"type":"string"},"title":{"type":"string"},"address":{"$ref":"#/definitions/KashFlow.Accounting.Model.CompanyHouse.Address"}}},"KashFlow.Accounting.Model.CompanyHouse.Address":{"type":"object","properties":{"locality":{"type":"string"},"postal_code":{"type":"string"},"address_line_1":{"type":"string"},"premises":{"type":"string"},"country":{"type":"string"}}},"KashFlow.Core.Model.Country":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Code":{"type":"string"},"Name":{"type":"string"},"IsEU":{"type":"boolean"}}},"KashFlow.Accounting.Model.Internal.Credit":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Amount":{"format":"double","type":"number"},"Date":{"type":"string"},"Type":{"type":"string"},"Comment":{"type":"string"},"IsAdvancePaymentOnCreditNote":{"type":"boolean"}}},"KashFlow.Accounting.Model.Currency":{"type":"object","properties":{"Code":{"type":"string"},"Symbol":{"type":"string"},"Name":{"type":"string"},"ExchangeRate":{"format":"double","type":"number"},"DisplaySymbolOnRight":{"type":"boolean"},"AutoUpdate":{"type":"boolean"}}},"KashFlow.Accounting.DTO.Base.CurrencyBase":{"type":"object","properties":{"Code":{"type":"string"},"Symbol":{"type":"string"},"Name":{"type":"string"},"ExchangeRate":{"format":"double","type":"number"},"AutoUpdate":{"type":"boolean"}}},"KashFlow.Accounting.Model.Customers.CustomerFilterParameters":{"type":"object","properties":{"Page":{"format":"int32","type":"integer"},"PerPage":{"format":"int32","type":"integer"},"Order":{"type":"string"},"SortBy":{"format":"int32","description":" 0 = Name,  1 = Code,  3 = TotalPaidAmount,  4 = OutstandingBalance","enum":[0,1,3,4],"type":"integer"},"Namestartswith":{"type":"string"},"Filterarchived":{"type":"boolean"},"SearchText":{"type":"string"},"StartCreationDate":{"type":"string"},"EndCreationDate":{"type":"string"},"SkipPerPageValidation":{"type":"boolean"}}},"KashFlow.Accounting.Model.Paging[KashFlow.Accounting.DTO.Customer.CustomerListResponse]":{"required":["Data"],"type":"object","properties":{"MetaData":{"$ref":"#/definitions/KashFlow.Accounting.Model.PagingMetadata"},"Data":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Customer.CustomerListResponse"}}}},"KashFlow.Accounting.DTO.Customer.CustomerListResponse":{"required":["Id","Code","Contacts"],"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Code":{"type":"string"},"Name":{"type":"string"},"Contacts":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Contact"}},"Addresses":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.CompanyDetails.Address"}},"TotalPaidAmount":{"format":"double","type":"number"},"OutstandingBalance":{"format":"double","type":"number"},"Currency":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Response.CurrencyResponse"},"IsSchedule":{"type":"boolean"},"SourceName":{"type":"string"},"DefaultNominalCode":{"format":"int32","type":"integer"},"IsArchived":{"type":"boolean"},"VATNumber":{"type":"string"},"TradeBorderType":{"type":"string"},"IsCISReverseCharge":{"type":"boolean"},"ApplyWithholdingTax":{"type":"boolean"},"CustomerKey":{"type":"string"}}},"KashFlow.Accounting.DTO.Contact":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"IsPrimary":{"type":"boolean"},"ReceiveEmails":{"type":"boolean"},"Name":{"type":"string"},"Title":{"type":"string"},"Firstname":{"type":"string"},"LastName":{"type":"string"},"Telephone":{"type":"string"},"Fax":{"type":"string"},"Mobile":{"type":"string"},"Website":{"type":"string"},"Email":{"type":"string"}}},"KashFlow.Accounting.DTO.Response.CurrencyResponse":{"required":["Code"],"type":"object","properties":{"Name":{"type":"string"},"Symbol":{"type":"string"},"DisplaySymbolOnRight":{"type":"boolean"},"Code":{"type":"string"},"ExchangeRate":{"format":"double","type":"number"}}},"KashFlow.Accounting.DTO.Customer.CustomerRequest":{"required":["Code"],"type":"object","properties":{"Code":{"type":"string"},"Name":{"type":"string"},"Source":{"format":"int32","type":"integer"},"Note":{"type":"string"},"DiscountRate":{"format":"double","type":"number"},"ShowDiscount":{"type":"boolean"},"AutoIncludeVATNumber":{"type":"boolean"},"ReceivesWholesalePricing":{"type":"boolean"},"DefaultCustomerReference":{"type":"string"},"EmailTemplateNumber":{"format":"int32","type":"integer"},"OverrideInvoiceFileFormat":{"type":"boolean"},"InvoiceFileFormat":{"type":"string"},"UniqueEntityNumber":{"type":"string"},"AutomaticCreditControlEnabled":{"type":"boolean"},"UseCustomDeliveryAddress":{"type":"boolean"},"WithholdingTaxRate":{"format":"double","type":"number"},"PDFThemeId":{"format":"int32","type":"integer"},"Currency":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Customer.CustomerCurrencyRequest"},"Contacts":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Contact"}},"Addresses":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Request.AddressRequest"}},"DeliveryAddresses":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Request.DeliveryAddressRequest"}},"WithholdingTaxReferences":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.CustomField"}},"PaymentTerms":{"$ref":"#/definitions/KashFlow.Accounting.DTO.PaymentTerms"},"CreateCustomerCodeIfDuplicate":{"type":"boolean"},"CreateCustomerNameIfEmptyOrNull":{"type":"boolean"},"CustomTextBoxes":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.CustomField"}},"CustomCheckBoxes":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.CustomField"}},"Id":{"format":"int32","type":"integer"},"EnableCreditLimit":{"type":"boolean"},"CreditLimit":{"format":"double","type":"number"},"DefaultNominalCode":{"format":"int32","type":"integer"},"IsArchived":{"type":"boolean"},"VATNumber":{"type":"string"},"TradeBorderType":{"type":"string"},"IsCISReverseCharge":{"type":"boolean"},"ApplyWithholdingTax":{"type":"boolean"},"CustomerKey":{"type":"string"}}},"KashFlow.Accounting.DTO.Customer.CustomerCurrencyRequest":{"required":["Code"],"type":"object","properties":{"Code":{"type":"string"}}},"KashFlow.Accounting.DTO.Request.AddressRequest":{"type":"object","properties":{"CountryCode":{"type":"string"},"Line1":{"type":"string"},"Line2":{"type":"string"},"Line3":{"type":"string"},"Line4":{"type":"string"},"PostCode":{"type":"string"}}},"KashFlow.Accounting.DTO.Request.DeliveryAddressRequest":{"type":"object","properties":{"Name":{"type":"string"},"CountryCode":{"type":"string"},"Line1":{"type":"string"},"Line2":{"type":"string"},"Line3":{"type":"string"},"Line4":{"type":"string"},"PostCode":{"type":"string"}}},"KashFlow.Accounting.DTO.CustomField":{"required":["Name","Value"],"type":"object","properties":{"Name":{"type":"string"},"Value":{"type":"string"}}},"KashFlow.Accounting.DTO.Customer.CustomerResponse":{"required":["Id","Code","EnvelopeUrl","Addresses","Contacts"],"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Code":{"type":"string"},"Name":{"type":"string"},"Source":{"format":"int32","type":"integer"},"Note":{"type":"string"},"DiscountRate":{"format":"double","type":"number"},"ShowDiscount":{"type":"boolean"},"AutoIncludeVATNumber":{"type":"boolean"},"ReceivesWholesalePricing":{"type":"boolean"},"DefaultCustomerReference":{"type":"string"},"EmailTemplateNumber":{"format":"int32","type":"integer"},"OverrideInvoiceFileFormat":{"type":"boolean"},"InvoiceFileFormat":{"type":"string"},"UniqueEntityNumber":{"type":"string"},"AutomaticCreditControlEnabled":{"type":"boolean"},"UseCustomDeliveryAddress":{"type":"boolean"},"WithholdingTaxRate":{"format":"double","type":"number"},"PDFThemeId":{"format":"int32","type":"integer"},"DisplayName":{"type":"string"},"CreatedDate":{"type":"string"},"InvoicedNetAmount":{"format":"double","type":"number"},"InvoicedVATAmount":{"format":"double","type":"number"},"InvoiceCount":{"format":"int32","type":"integer"},"IsGoCardlessMandateSet":{"type":"boolean"},"EnvelopeUrl":{"type":"string"},"UsesDefaultTheme":{"type":"boolean"},"AverageDaysToPay":{"format":"int32","type":"integer"},"OverdueAmount":{"format":"double","type":"number"},"FirstInvoiceDate":{"type":"string"},"LastInvoiceDate":{"type":"string"},"Addresses":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Response.AddressResponse"}},"DeliveryAddresses":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Response.DeliveryAddressResponse"}},"WithholdingTaxReferences":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.CustomField"}},"CustomTextBoxes":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.CustomField"}},"CustomCheckBoxes":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.CustomField"}},"PaymentTerms":{"$ref":"#/definitions/KashFlow.Accounting.DTO.PaymentTerms"},"LastUpdatedDate":{"type":"string"},"EnableCreditLimit":{"type":"boolean"},"CreditLimit":{"format":"double","type":"number"},"MarkedAsStale":{"type":"boolean"},"Contacts":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Contact"}},"TotalPaidAmount":{"format":"double","type":"number"},"OutstandingBalance":{"format":"double","type":"number"},"Currency":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Response.CurrencyResponse"},"IsSchedule":{"type":"boolean"},"SourceName":{"type":"string"},"DefaultNominalCode":{"format":"int32","type":"integer"},"IsArchived":{"type":"boolean"},"VATNumber":{"type":"string"},"TradeBorderType":{"type":"string"},"IsCISReverseCharge":{"type":"boolean"},"ApplyWithholdingTax":{"type":"boolean"},"CustomerKey":{"type":"string"}}},"KashFlow.Accounting.DTO.Response.AddressResponse":{"type":"object","properties":{"CountryName":{"type":"string"},"CountryCode":{"type":"string"},"Line1":{"type":"string"},"Line2":{"type":"string"},"Line3":{"type":"string"},"Line4":{"type":"string"},"PostCode":{"type":"string"}}},"KashFlow.Accounting.DTO.Response.DeliveryAddressResponse":{"type":"object","properties":{"CountryName":{"type":"string"},"Name":{"type":"string"},"CountryCode":{"type":"string"},"Line1":{"type":"string"},"Line2":{"type":"string"},"Line3":{"type":"string"},"Line4":{"type":"string"},"PostCode":{"type":"string"}}},"System.Collections.Generic.KeyValuePair[System.Int32,System.String]":{"type":"object","properties":{"key":{"format":"int32","type":"integer"},"value":{"type":"string"}}},"KashFlow.Accounting.Model.CustomerStatistics":{"type":"object","properties":{"FirstTransactionDate":{"type":"string"},"LastTransactionDate":{"type":"string"},"AverageTimeToPay":{"type":"string"},"TotalInvoiced":{"type":"string"},"AmountDue":{"type":"string"},"AmountOverdue":{"type":"string"}}},"KashFlow.Accounting.Model.CustomersStatistics":{"type":"object","properties":{"TotalInvoiced":{"type":"string"},"AmountDue":{"type":"string"},"AmountOverdue":{"type":"string"}}},"KashFlow.Accounting.Model.CustomerMassDeleteStatus":{"type":"object","properties":{"Code":{"type":"string"},"CustomerCanBeDelete":{"type":"boolean"},"Reason":{"type":"string"}}},"KashFlow.Accounting.Model.Customer":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"DisplayName":{"type":"string"},"Code":{"type":"string"},"Name":{"type":"string"},"Source":{"format":"int32","type":"integer"},"CreatedDate":{"type":"string"},"LastUpdatedDate":{"type":"string"},"TradeBorderType":{"type":"string"},"Note":{"type":"string"},"DiscountRate":{"format":"double","type":"number"},"ShowDiscount":{"type":"boolean"},"VATNumber":{"type":"string"},"AutoIncludeVATNumber":{"type":"boolean"},"TotalPaidAmount":{"format":"double","type":"number"},"InvoicedNetAmount":{"format":"double","type":"number"},"InvoicedVATAmount":{"format":"double","type":"number"},"ReceivesWholesalePricing":{"type":"boolean"},"DefaultNominalCode":{"format":"int32","type":"integer"},"IsArchived":{"type":"boolean"},"InvoiceCount":{"format":"int32","type":"integer"},"Currency":{"$ref":"#/definitions/KashFlow.Accounting.Model.Currency"},"DefaultCustomerReference":{"type":"string"},"EmailTemplateNumber":{"format":"int32","type":"integer"},"OverrideInvoiceFileFormat":{"type":"boolean"},"InvoiceFileFormat":{"type":"string"},"FirstInvoiceDate":{"type":"string"},"LastInvoiceDate":{"type":"string"},"UniqueEntityNumber":{"type":"string"},"AutomaticCreditControlEnabled":{"type":"boolean"},"Contacts":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Contact"}},"Addresses":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Core.Model.Address"}},"UseCustomDeliveryAddress":{"type":"boolean"},"DeliveryAddresses":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.DeliveryAddress"}},"CustomTextBoxes":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.CustomField"}},"CustomCheckBoxes":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.CustomField"}},"IsCISReverseCharge":{"type":"boolean"},"ApplyWithholdingTax":{"type":"boolean"},"WithholdingTaxRate":{"format":"double","type":"number"},"WithholdingTaxReferences":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.CustomField"}},"OutstandingBalance":{"format":"double","type":"number"},"IsGoCardlessMandateSet":{"type":"boolean"},"PaymentTerms":{"$ref":"#/definitions/KashFlow.Accounting.Model.PaymentTerms"},"CreateCustomerCodeIfDuplicate":{"type":"boolean"},"CreateCustomerNameIfEmptyOrNull":{"type":"boolean"},"EnvelopeUrl":{"type":"string"},"PDFThemeId":{"format":"int32","type":"integer"},"UsesDefaultTheme":{"type":"boolean"},"AverageDaysToPay":{"format":"int32","type":"integer"},"OverdueAmount":{"format":"double","type":"number"},"doesCustomerHasTransactionsInVATReturn":{"type":"boolean"},"IsSchedule":{"type":"boolean"},"EnableCreditLimit":{"type":"boolean"},"CreditLimit":{"format":"double","type":"number"},"MarkedAsStale":{"type":"boolean"},"CustomerKey":{"type":"string"}}},"KashFlow.Accounting.Model.Contact":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"IsPrimary":{"type":"boolean"},"ReceiveEmails":{"type":"boolean"},"Name":{"type":"string"},"Title":{"type":"string"},"Firstname":{"type":"string"},"LastName":{"type":"string"},"Telephone":{"type":"string"},"Fax":{"type":"string"},"Mobile":{"type":"string"},"Website":{"type":"string"},"Email":{"type":"string"}}},"KashFlow.Accounting.Model.DeliveryAddress":{"type":"object","properties":{"Name":{"type":"string"},"Line1":{"type":"string"},"Line2":{"type":"string"},"Line3":{"type":"string"},"Line4":{"type":"string"},"PostCode":{"type":"string"},"CountryName":{"type":"string"},"CountryCode":{"type":"string"},"CountryId":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.CustomField":{"type":"object","properties":{"Name":{"type":"string"},"Value":{"type":"string"}}},"KashFlow.Accounting.Model.PaymentTerms":{"type":"object","properties":{"Type":{"type":"string"},"Days":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.Customers.CustomerBulkInvoiceDetails":{"type":"object","properties":{"CustomerCode":{"type":"string"},"CustomerName":{"type":"string"},"NetAmount":{"format":"double","type":"number"},"VATAmount":{"format":"double","type":"number"},"PaidAmount":{"format":"double","type":"number"},"InvoicesCount":{"format":"int32","type":"integer"},"LastInvoiceDate":{"format":"int64","type":"integer"}}},"KashFlow.Accounting.Model.Customers.StandingOrderMandate":{"type":"object","properties":{"AccountName":{"type":"string"},"AccountAddress":{"$ref":"#/definitions/KashFlow.Core.Model.Address"},"AccountNumber":{"type":"string"},"AccountSort":{"type":"string"},"PayFrequency":{"type":"string"},"GrossAmount":{"format":"double","type":"number"},"DueDate":{"format":"date-time","type":"string"},"IsSaveBank":{"type":"boolean"},"IsSavePayFreq":{"type":"boolean"}}},"KashFlow.Accounting.Model.Customers.ScheduleStatementInsertRequest":{"type":"object","properties":{"CustomerCodes":{"type":"array","items":{"type":"string"}},"IsSchedule":{"type":"boolean"},"IssueDay":{"format":"int32","type":"integer"},"IsLastDay":{"type":"boolean"},"TransactionPeriod":{"type":"string"},"EndDate":{"type":"string"},"IsPaidInvoice":{"type":"boolean"},"IsOpeningBal":{"type":"boolean"},"IsTotalOwed":{"type":"boolean"}}},"KashFlow.Accounting.Model.Customers.ScheduleStatement":{"type":"object","properties":{"IsSchedule":{"type":"boolean"},"IssueDay":{"format":"int32","type":"integer"},"IsLastDay":{"type":"boolean"},"TransactionPeriod":{"type":"string"},"EndDate":{"type":"string"},"IsPaidInvoice":{"type":"boolean"},"IsOpeningBal":{"type":"boolean"},"IsTotalOwed":{"type":"boolean"}}},"KashFlow.Accounting.Model.Settings.CustomerAndSupplierSettings":{"type":"object","properties":{"ShowCustomerPostcode":{"type":"boolean"},"CustomerDisplayFormat":{"type":"string"},"IncludeDueDateOnCustomerStatement":{"type":"boolean"},"IncludeDueDateOnSupplierStatement":{"type":"boolean"},"IncludePaymentMethodOnCustomerStatement":{"type":"boolean"},"IncludePaymentMethodOnSupplierStatement":{"type":"boolean"},"UENEnabledForCustomers":{"type":"boolean"},"UENEnabledForSuppliers":{"type":"boolean"},"UENNameForCustomers":{"type":"string"},"UENNameForSuppliers":{"type":"string"}}},"KashFlow.Accounting.Model.DateIntervalFilterBy":{"type":"object","properties":{"StartDate":{"type":"string"},"EndDate":{"type":"string"}}},"KashFlow.Accounting.Model.Paging[KashFlow.Accounting.Model.CustomerTransaction]":{"required":["Data"],"type":"object","properties":{"MetaData":{"$ref":"#/definitions/KashFlow.Accounting.Model.PagingMetadata"},"Data":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.CustomerTransaction"}}}},"KashFlow.Accounting.Model.CustomerTransaction":{"type":"object","properties":{"Type":{"format":"int32","description":" 0 = Unknown,  1 = Invoice,  2 = Payment,  3 = Quote,  6 = CreditNote","enum":[0,1,2,3,6],"type":"integer"},"PackingSlipPermalink":{"type":"string"},"StatusNumber":{"format":"int32","type":"integer"},"Status":{"type":"string"},"Id":{"format":"int64","type":"integer"},"Number":{"format":"int64","type":"integer"},"ParentNumber":{"format":"int64","type":"integer"},"Date":{"type":"string"},"Project":{"type":"string"},"Amount":{"format":"double","type":"number"},"Permalink":{"type":"string"},"Reference":{"type":"string"}}},"KashFlow.Accounting.Model.Dashboard.DashboardBusinessWidget":{"type":"object","properties":{"HasOneAccountingPeriod":{"type":"boolean"},"DashboardBusinessDetails":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Dashboard.DashboardBusinessDetails"}}}},"KashFlow.Accounting.Model.Dashboard.DashboardBusinessDetails":{"type":"object","properties":{"Type":{"type":"string"},"DashboardBusinessEntities":{"$ref":"#/definitions/KashFlow.Accounting.Model.Dashboard.DashboardBusninessEntities"}}},"KashFlow.Accounting.Model.Dashboard.DashboardBusninessEntities":{"type":"object","properties":{"CurrentValue":{"format":"double","type":"number"},"PreviousValue":{"format":"double","type":"number"},"Health":{"type":"boolean"},"DifferenceValue":{"format":"double","type":"number"},"Contributors":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Dashboard.DashboardBusinessItem"}}}},"KashFlow.Accounting.Model.Dashboard.DashboardBusinessItem":{"type":"object","properties":{"Name":{"type":"string"},"Amount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.Dashboard.WidgetsLayout":{"type":"object","properties":{"Left":{"type":"string"},"Right":{"type":"string"}}},"KashFlow.Accounting.Model.Dashboard.DisplaySettings":{"type":"object","properties":{"ShowGettingStartedSection":{"type":"boolean"},"ShowMessages":{"type":"boolean"},"ShowFinancialSummary":{"type":"boolean"},"ShowFinancialGraph":{"type":"boolean"},"ShowQuickLinks":{"type":"boolean"},"ShowDoYouKnowSection":{"type":"boolean"},"ShowVATLiability":{"type":"boolean"},"SuppressVATWarning":{"type":"boolean"},"ShowChangeLog":{"type":"boolean"},"ShowReferral":{"type":"boolean"},"ShowQuotesSummary":{"type":"boolean"},"ShowPaymentProcessor":{"type":"boolean"},"ShowMTDOverview":{"type":"boolean"},"ShowAnnouncement":{"type":"boolean"},"ShowInAppPromotion":{"type":"boolean"},"ShowUnipaasEwalletDisplaySetting":{"type":"boolean"},"ShowUnipaasEwalletPromotion":{"type":"boolean"},"ShowBusinessWidget":{"type":"boolean"},"ShowBusinessWidgetPermission":{"type":"boolean"},"VatThresholdStatus":{"type":"boolean"},"ShowITSAThresholdStatus":{"type":"boolean"}}},"KashFlow.Accounting.Model.DuplicateEntity":{"type":"object","properties":{"SourceNumber":{"format":"int32","type":"integer"},"TargetId":{"format":"int32","type":"integer"},"TargetNumber":{"format":"int32","type":"integer"},"SourceType":{"type":"string"},"TargetType":{"type":"string"}}},"KashFlow.Accounting.Model.VAT.ECSLVatNumberError.ECSLVatNumberErrorDetails":{"type":"object","properties":{"VatReturnId":{"format":"int64","type":"integer"},"StartDate":{"format":"date-time","type":"string"},"EndDate":{"format":"date-time","type":"string"},"VATReturnTimeStamp":{"format":"date-time","type":"string"},"HasSalesList":{"type":"boolean"},"HasInvalidVATNumbers":{"type":"boolean"},"Customers":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.VAT.ECSLVatNumberError.ECSLVatNumberErrorCustomer"}}}},"KashFlow.Accounting.Model.VAT.ECSLVatNumberError.ECSLVatNumberErrorCustomer":{"type":"object","properties":{"ECSLSubmissionId":{"format":"int64","type":"integer"},"SubmitterRef":{"format":"int32","type":"integer"},"CountryCode":{"type":"string"},"VatNumber":{"type":"string"},"TotalValue":{"format":"double","type":"number"},"CustomerId":{"format":"int32","type":"integer"},"CustomerCode":{"type":"string"},"CustomerName":{"type":"string"},"IsVATNumberValid":{"type":"boolean"}}},"KashFlow.Accounting.Model.VAT.ECSLVatNumberError.ECSLVatNumberErrorUpdateRequest":{"type":"object","properties":{"Mode":{"format":"int32","description":" 0 = None,  1 = Check,  2 = Update","enum":[0,1,2],"type":"integer"},"Data":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.VAT.ECSLVatNumberError.ECSLVatNumberErrorUpdateDetail"}}}},"KashFlow.Accounting.Model.VAT.ECSLVatNumberError.ECSLVatNumberErrorUpdateDetail":{"type":"object","properties":{"ECSLSubmissionId":{"format":"int64","type":"integer"},"CountryCode":{"type":"string"},"VatNumber":{"type":"string"},"IsValidVatNumber":{"type":"boolean"}}},"KashFlow.Accounting.Model.Email.EmailMessage":{"type":"object","properties":{"To":{"type":"string"},"Cc":{"type":"string"},"Bcc":{"type":"string"},"Subject":{"type":"string"},"Body":{"type":"string"},"Attachments":{"$ref":"#/definitions/KashFlow.Accounting.Model.MailAttachment"},"IsHtml":{"type":"boolean"},"SenderAddress":{"type":"string"},"SenderName":{"type":"string"},"CustCode":{"type":"string"},"SupplierCode":{"type":"string"},"EntityId":{"format":"int32","type":"integer"},"EntityNumber":{"format":"int32","type":"integer"},"EntityType":{"type":"string"},"SubEntityType":{"type":"string"},"TemplateNumber":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.MailAttachment":{"type":"object","properties":{"DocumentUrls":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Email.DocumentUrlAttachment"}},"FileAttachments":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Email.FileAttachment"}}}},"KashFlow.Accounting.Model.Email.DocumentUrlAttachment":{"type":"object","properties":{"FileName":{"type":"string"},"Url":{"type":"string"}}},"KashFlow.Accounting.Model.Email.FileAttachment":{"type":"object","properties":{"Name":{"type":"string"},"AttachmentContent":{"type":"string"}}},"KashFlow.Accounting.Model.Paging[KashFlow.Accounting.Model.Reports.EmailLog.EmailLog]":{"required":["Data"],"type":"object","properties":{"MetaData":{"$ref":"#/definitions/KashFlow.Accounting.Model.PagingMetadata"},"Data":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.EmailLog.EmailLog"}}}},"KashFlow.Accounting.Model.Reports.EmailLog.EmailLog":{"required":["Status","FromName","FromEmailId","CreatedTimestamp","SentTimestamp","RecipientEmailId","RecipientType","UsesCustomSmtp"],"type":"object","properties":{"Status":{"type":"string"},"Subject":{"type":"string"},"FromName":{"type":"string"},"FromEmailId":{"type":"string"},"CreatedTimestamp":{"format":"date-time","type":"string"},"SentTimestamp":{"format":"date-time","type":"string"},"RecipientEmailId":{"type":"string"},"RecipientType":{"type":"string"},"UsesCustomSmtp":{"type":"boolean"},"ErrorMessage":{"type":"string"}}},"KashFlow.Accounting.Model.Email.EmailOptions":{"type":"object","properties":{"SendEmailOverdueSales":{"type":"boolean"},"SendEmailOverduePurchases":{"type":"boolean"},"BCCEmails":{"type":"boolean"},"BCCAddress":{"type":"string"},"EnablePaymentNotification":{"type":"boolean"}}},"KashFlow.Accounting.RestApi.Parameters.ExpenseFilterParameters":{"type":"object","properties":{"Page":{"format":"int32","description":"Page number. (default is 1)","type":"integer"},"PerPage":{"format":"int32","description":"PerPage is number of records per page. (default is 10)","type":"integer"},"Order":{"description":"Sorting order (asc or desc) (default is asc)","type":"string"},"SortBy":{"format":"int32","description":"Sort By column/field name. (default is Number) 0 = Number,  1 = SupplierReference,  2 = SupplierName,  3 = PurchaseDate,  4 = PaymentDueDate,  5 = GrossAmount,  6 = NetAmount,  7 = Status,  8 = PaidDate,  9 = DueAmount,  10 = Type,  11 = Project,  12 = VAT","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12],"type":"integer"},"FilterBy":{"format":"int32","description":"Sort By column/field name. (default is All) 0 = All,  1 = Unpaid,  2 = PartPaid,  3 = Overdue,  4 = OverduePartPaid,  5 = Overpaid,  6 = Paid,  7 = NotFullyPaid,  8 = ThisMonth,  9 = LastMonth","enum":[0,1,2,3,4,5,6,7,8,9],"type":"integer"},"SupplierCode":{"description":"sort expense having code starting with the provided string","type":"string"},"SearchText":{"description":"Search expense by text","type":"string"}}},"KashFlow.Accounting.Model.Paging[KashFlow.Accounting.DTO.Expense.ExpenseListResponse]":{"required":["Data"],"type":"object","properties":{"MetaData":{"$ref":"#/definitions/KashFlow.Accounting.Model.PagingMetadata"},"Data":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Expense.ExpenseListResponse"}}}},"KashFlow.Accounting.DTO.Expense.ExpenseListResponse":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Number":{"format":"int32","type":"integer"},"SupplierCode":{"type":"string"},"SupplierName":{"type":"string"},"Currency":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Response.CurrencyResponse"},"FileCount":{"format":"int32","type":"integer"},"ExpenseArticle":{"type":"string"},"IssuedDate":{"type":"string"},"Amount":{"format":"double","type":"number"},"VATLevel":{"format":"double","type":"number"},"VATExempt":{"type":"boolean"},"Disallowed":{"type":"boolean"},"DisableDisallowed":{"type":"boolean"}}},"KashFlow.Accounting.DTO.Expense.ExpenseRequest":{"type":"object","properties":{"Number":{"format":"int32","type":"integer"},"SupplierCode":{"type":"string"},"BankAccountId":{"format":"int32","type":"integer"},"PaymentMethod":{"format":"int64","type":"integer"},"NominalCode":{"format":"int32","type":"integer"},"Comment":{"type":"string"},"BFSTransactionId":{"format":"int64","type":"integer"},"ExpenseArticle":{"type":"string"},"IssuedDate":{"type":"string"},"Amount":{"format":"double","type":"number"},"VATLevel":{"format":"double","type":"number"},"VATExempt":{"type":"boolean"},"Disallowed":{"type":"boolean"},"DisableDisallowed":{"type":"boolean"}}},"KashFlow.Accounting.DTO.Expense.ExpenseResponse":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Number":{"format":"int32","type":"integer"},"SupplierCode":{"type":"string"},"SupplierName":{"type":"string"},"BankAccountId":{"format":"int32","type":"integer"},"PaymentMethod":{"format":"int64","type":"integer"},"NominalCode":{"format":"int32","type":"integer"},"VATReturnId":{"format":"int64","type":"integer"},"Comment":{"type":"string"},"BFSTransactionId":{"format":"int64","type":"integer"},"Currency":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Response.CurrencyResponse"},"FileCount":{"format":"int32","type":"integer"},"ExpenseArticle":{"type":"string"},"IssuedDate":{"type":"string"},"Amount":{"format":"double","type":"number"},"VATLevel":{"format":"double","type":"number"},"VATExempt":{"type":"boolean"},"Disallowed":{"type":"boolean"},"DisableDisallowed":{"type":"boolean"}}},"KashFlow.Accounting.Model.Reports.FixedAssetReport":{"type":"object","properties":{"Startdate":{"format":"int64","type":"integer"},"Enddate":{"format":"int64","type":"integer"},"CategoryList":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.AssetCategoryDetails"}},"AllCategoriesCostBtfwd":{"format":"double","type":"number"},"AllCategoriesAdditions":{"format":"double","type":"number"},"AllCategoriesTotalCost":{"format":"double","type":"number"},"AllCategoriesDepreciationbtfwd":{"format":"double","type":"number"},"AllCategoriesSLDepreciation":{"format":"double","type":"number"},"AllCategoriesTotalDepreciation":{"format":"double","type":"number"},"AllCategoriesNBVstartOfYear":{"format":"double","type":"number"},"AllCategoriesNBVEndOfYear":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.Reports.AssetCategoryDetails":{"type":"object","properties":{"CategoryId":{"format":"int32","type":"integer"},"CategoryName":{"type":"string"},"FixedAssetsList":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.FixedAsset"}},"TotalCostBtFwd":{"format":"double","type":"number"},"TotalAdditions":{"format":"double","type":"number"},"TotalCost":{"format":"double","type":"number"},"TotaldeptBtFwd":{"format":"double","type":"number"},"TotalDept":{"format":"double","type":"number"},"SumTotalDept":{"format":"double","type":"number"},"TotalNBVStart":{"format":"double","type":"number"},"TotalNBVEnd":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.Reports.FixedAsset":{"type":"object","properties":{"AssetId":{"format":"int32","type":"integer"},"AssetName":{"type":"string"},"Description":{"type":"string"},"PurchaseDate":{"format":"int64","type":"integer"},"Reference":{"type":"string"},"PurchaseNo":{"format":"int32","type":"integer"},"DecpreciationMethod":{"type":"string"},"DecpreciationRate":{"type":"string"},"NoOfMonthsDept":{"format":"int32","type":"integer"},"CostBroughtForword":{"format":"double","type":"number"},"Additions":{"format":"double","type":"number"},"TotalCost":{"format":"double","type":"number"},"DeptBroughtForword":{"format":"double","type":"number"},"SLDept":{"format":"double","type":"number"},"TotalDept":{"format":"double","type":"number"},"NBVStartofYear":{"format":"double","type":"number"},"NBVEndofYear":{"format":"double","type":"number"}}},"KashFlow.Accounting.DTO.FixedAssetRegister.AssetCategoryRequest":{"type":"object","properties":{"Name":{"type":"string"},"Description":{"type":"string"},"DepreciationMethod":{"format":"int32","description":" 0 = StraightLine,  1 = ReducingBalance","enum":[0,1],"type":"integer"},"DepreciationMonths":{"format":"int32","type":"integer"},"DepreciationPercentage":{"format":"double","type":"number"},"DebitCode":{"format":"int32","type":"integer"},"CreditCode":{"format":"int32","type":"integer"},"DepreciatedSoFar":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.Reports.FixedAssetRegister.FixedAssetCategory":{"type":"object","properties":{"Number":{"format":"int32","type":"integer"},"Name":{"type":"string"},"Description":{"type":"string"},"DepreciationMethod":{"format":"int32","description":" 0 = StraightLine,  1 = ReducingBalance","enum":[0,1],"type":"integer"},"DepreciationMonths":{"format":"int32","type":"integer"},"DepreciationPercentage":{"format":"double","type":"number"},"DebitCode":{"format":"int32","type":"integer"},"CreditCode":{"format":"int32","type":"integer"},"DepreciatedSoFar":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.Reports.AssetCategory":{"type":"object","properties":{"CategoryId":{"format":"int32","type":"integer"},"CategoryName":{"type":"string"}}},"KashFlow.Accounting.DTO.FixedAssetRegister.CategoryListResponse":{"type":"object","properties":{"Number":{"format":"int32","type":"integer"},"Name":{"type":"string"},"Description":{"type":"string"}}},"KashFlow.Accounting.Model.Reports.FixedAssetRegister.Asset":{"type":"object","properties":{"Name":{"type":"string"},"Number":{"format":"int32","type":"integer"},"Reference":{"type":"string"},"Description":{"type":"string"},"SerialNumber":{"type":"string"},"Location":{"type":"string"},"PurchaseDate":{"type":"string"},"DepreciationDate":{"type":"string"},"SupplierCode":{"type":"string"},"StartingAmount":{"format":"double","type":"number"},"CategoryNumber":{"format":"int32","type":"integer"},"PurchaseLineId":{"format":"int32","type":"integer"},"DepreciationMethod":{"format":"int32","description":" 0 = StraightLine,  1 = ReducingBalance","enum":[0,1],"type":"integer"},"DepreciationMonths":{"format":"int32","type":"integer"},"DepreciationPercentage":{"format":"double","type":"number"},"DebitCode":{"format":"int32","type":"integer"},"CreditCode":{"format":"int32","type":"integer"},"DepreciatedSoFar":{"format":"double","type":"number"}}},"KashFlow.Accounting.DTO.FixedAssetRegister.AssetRegisterItemResponse":{"type":"object","properties":{"Name":{"type":"string"},"Reference":{"type":"string"},"Description":{"type":"string"},"SerialNumber":{"type":"string"},"Location":{"type":"string"},"PurchaseDate":{"type":"string"},"DepreciationDate":{"type":"string"},"SupplierCode":{"type":"string"},"StartingAmount":{"format":"double","type":"number"},"CategoryNumber":{"format":"int32","type":"integer"},"DepreciationMethod":{"format":"int32","description":" 0 = StraightLine,  1 = ReducingBalance","enum":[0,1],"type":"integer"},"DepreciationMonths":{"format":"int32","type":"integer"},"DepreciationPercentage":{"format":"double","type":"number"},"DebitCode":{"format":"int32","type":"integer"},"CreditCode":{"format":"int32","type":"integer"},"DepreciatedSoFar":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.Reports.FixedAssetRegister.AssetDetails":{"type":"object","properties":{"CategoryNumber":{"format":"int32","type":"integer"},"CategoryName":{"type":"string"},"AssetNumber":{"format":"int32","type":"integer"},"AssetName":{"type":"string"},"Reference":{"type":"string"},"Cost":{"format":"double","type":"number"},"JournalsCount":{"format":"int32","type":"integer"},"DepreciationMethod":{"format":"int32","description":" 0 = StraightLine,  1 = ReducingBalance","enum":[0,1],"type":"integer"},"DepreciationMonths":{"format":"int32","type":"integer"},"DepreciationPercentage":{"format":"double","type":"number"},"DebitCode":{"format":"int32","type":"integer"},"CreditCode":{"format":"int32","type":"integer"},"DepreciatedSoFar":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.Reports.FixedAssetRegister.PendingAsset":{"type":"object","properties":{"PurchaseLineId":{"format":"int32","type":"integer"},"PurchaseNumber":{"format":"int32","type":"integer"},"PurchaseDate":{"type":"string"},"SupplierName":{"type":"string"},"SupplierCode":{"type":"string"},"NominalCode":{"type":"string"},"Total":{"format":"double","type":"number"},"Description":{"type":"string"},"Reference":{"type":"string"}}},"KashFlow.Accounting.Model.Journal":{"type":"object","properties":{"Number":{"format":"int32","type":"integer"},"Id":{"format":"int32","type":"integer"},"Comment":{"type":"string"},"Category":{"format":"int32","description":" 0 = StandardJournals,  1 = YearEndJournals,  2 = PrePaymentAndAccruals,  3 = Deprecation,  4 = Wages,  5 = VAT,  6 = VATMoss,  7 = FRSAdjustmentJournal,  -1 = AllCategories","enum":[0,1,2,3,4,5,6,7,-1],"type":"integer"},"ExcludedFromProfitAndLoss":{"type":"boolean"},"LineItems":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.JournalLineItem"}},"ReadOnly":{"type":"boolean"},"JournalDate":{"format":"date-time","type":"string"},"IsTemplate":{"type":"boolean"},"TemplateName":{"type":"string"},"Notes":{"type":"string"},"TotalAmount":{"format":"double","type":"number"},"VATReturnId":{"format":"int32","type":"integer"},"CategoryDescription":{"type":"string"},"TradeBorderType":{"type":"string"},"JournalName":{"type":"string","readOnly":true},"LockedBankLines":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.JournalLineItem":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"NominalId":{"format":"int32","type":"integer"},"NominalCode":{"format":"int32","type":"integer"},"NominalName":{"type":"string"},"Comment":{"type":"string"},"Debit":{"format":"double","type":"number"},"Credit":{"format":"double","type":"number"},"ProjectId":{"format":"int32","type":"integer"},"ProjectNumber":{"format":"int32","type":"integer"},"ProjectName":{"type":"string"},"Disallowed":{"type":"boolean"},"DisableDisallowed":{"type":"boolean"}}},"KashFlow.Accounting.Model.GoCardlessWebhookEvents":{"type":"object","properties":{"events":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.GoCardlessWebhookEvent"}}}},"KashFlow.Accounting.Model.GoCardlessWebhookEvent":{"type":"object","properties":{"id":{"type":"string"},"created_at":{"type":"string"},"action":{"type":"string"},"resource_type":{"type":"string"},"links":{"$ref":"#/definitions/KashFlow.Accounting.Model.GoCardlessWebhookEventLinks"},"details":{"$ref":"#/definitions/KashFlow.Accounting.Model.GoCardlessWebhookEventDetails"}}},"KashFlow.Accounting.Model.GoCardlessWebhookEventLinks":{"type":"object","properties":{"Payment":{"type":"string"},"Payout":{"type":"string"},"Mandate":{"type":"string"},"Organisation":{"type":"string"},"Parent_event":{"type":"string"}}},"KashFlow.Accounting.Model.GoCardlessWebhookEventDetails":{"type":"object","properties":{"origin":{"type":"string"},"cause":{"type":"string"},"description":{"type":"string"},"scheme":{"type":"string"},"reason_code":{"type":"string"}}},"KashFlow.Accounting.Model.Zendesk.ZendeskRequest":{"type":"object","properties":{"Subject":{"type":"string"},"Description":{"type":"string"},"Email":{"type":"string"},"Name":{"type":"string"},"Browser":{"type":"string"},"BrowserVersion":{"format":"float","type":"number"},"Attachments":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Zendesk.Attachment"}}}},"KashFlow.Accounting.Model.Zendesk.Attachment":{"type":"object","properties":{"Name":{"type":"string"},"Content":{"type":"string"}}},"KashFlow.Accounting.RestApi.Parameters.InvoiceFilterParameters":{"type":"object","properties":{"Page":{"format":"int32","description":"Page number. (default is 1)","type":"integer"},"PerPage":{"format":"int32","description":"PerPage is number of records per page. (default is 50)","type":"integer"},"Order":{"description":"Sorting order (asc or desc) (default is asc)","type":"string"},"SortBy":{"format":"int32","description":"Sort By column/field name. (default is Number) 0 = Number,  1 = CustomerRef,  2 = CustomerName,  3 = InvoiceDate,  4 = PaymentDueDate,  5 = GrossAmount,  6 = NetAmount,  7 = Status,  8 = PaymentPaidDate,  9 = DueAmount,  10 = Type,  11 = VATAmount,  12 = Project","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12],"type":"integer"},"CustomerCode":{"description":"Customer code","type":"string"},"StatusFilter":{"description":"Status Filter","type":"string"},"ProjectNumber":{"format":"int32","description":"Project Number","type":"integer"},"IssueDateFrom":{"description":"For issue date filter","type":"string"},"IssueDateTo":{"description":"For issue date filter","type":"string"},"SearchText":{"description":"Reference","type":"string"},"Source":{"description":"Send \"MatchingEngine\" if request has been sent from matching engine otherwise empty(\"\").\r\n            In the case of Source as \"MatchingEngine\", API will consider \"Customer code\",\"Project Number\" and \"Issue date filter\" fields are default values","type":"string"},"Archived":{"description":"For archived filter","type":"string"},"DoSearchWithDueAmount":{"description":"For search with due amount","type":"boolean"}}},"KashFlow.Accounting.Model.Paging[KashFlow.Accounting.DTO.Invoice.InvoiceListResponse]":{"required":["Data"],"type":"object","properties":{"MetaData":{"$ref":"#/definitions/KashFlow.Accounting.Model.PagingMetadata"},"Data":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Invoice.InvoiceListResponse"}}}},"KashFlow.Accounting.DTO.Invoice.InvoiceListResponse":{"required":["IssuedDate","CustomerCode"],"type":"object","properties":{"Number":{"format":"int32","type":"integer"},"IssuedDate":{"type":"string"},"DueDate":{"type":"string"},"PaidDate":{"type":"string"},"VATAmount":{"format":"double","type":"number"},"NetAmount":{"format":"double","type":"number"},"TotalPaidAmount":{"format":"double","type":"number"},"GrossAmount":{"format":"double","type":"number"},"Status":{"type":"string"},"HomeCurrencyGrossAmount":{"format":"double","type":"number"},"ProjectGrossAmount":{"format":"double","type":"number"},"CustomerName":{"type":"string"},"CustomerId":{"format":"int32","type":"integer"},"EmailCount":{"format":"int32","type":"integer"},"OverdueDays":{"format":"int32","type":"integer"},"DueAmount":{"format":"double","type":"number"},"ProjectName":{"type":"string"},"FileCount":{"format":"int32","type":"integer"},"VATReturnId":{"format":"int64","type":"integer"},"Type":{"type":"string"},"TradeBorderType":{"type":"string"},"IsArchived":{"type":"boolean"},"LineItems":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.InvoiceLineItem"}},"Address":{"$ref":"#/definitions/KashFlow.Accounting.Model.BillingAddress"},"Currency":{"$ref":"#/definitions/KashFlow.Accounting.Model.Currency"},"HomeCurrencyVATAmount":{"format":"double","type":"number"},"CISRCVatAmount":{"format":"double","type":"number"},"Id":{"format":"int32","type":"integer"},"ProjectNumber":{"format":"int32","type":"integer"},"IsCISReverseCharge":{"type":"boolean"},"CustomerCode":{"type":"string"},"CustomerReference":{"type":"string"},"AutomaticCreditControlEnabled":{"type":"boolean"},"CustomerKey":{"type":"string"}}},"KashFlow.Accounting.Model.InvoiceLineItem":{"type":"object","properties":{"ProjectNumber":{"format":"int32","type":"integer"},"ProjectName":{"type":"string"},"Tax1Amount":{"format":"double","type":"number"},"Tax2Amount":{"format":"double","type":"number"},"Tax3Amount":{"format":"double","type":"number"},"Tax4Amount":{"format":"double","type":"number"},"Tax5Amount":{"format":"double","type":"number"},"ApplyTax1":{"type":"boolean"},"ApplyTax2":{"type":"boolean"},"ApplyTax3":{"type":"boolean"},"ApplyTax4":{"type":"boolean"},"ApplyTax5":{"type":"boolean"},"NominalName":{"type":"string"},"Number":{"format":"int32","type":"integer"},"Description":{"type":"string"},"Quantity":{"format":"double","type":"number"},"Rate":{"format":"double","type":"number"},"HomeCurrencyRate":{"format":"double","type":"number"},"VATLevel":{"format":"double","type":"number"},"VATExempt":{"type":"boolean"},"VATAmount":{"format":"double","type":"number"},"HomeCurrencyVATAmount":{"format":"double","type":"number"},"NominalId":{"format":"int32","type":"integer"},"NominalCode":{"format":"int32","type":"integer"},"ProductCode":{"type":"string"},"ProductName":{"type":"string"},"TaxCode":{"type":"string"},"Disallowed":{"type":"boolean"},"DisableDisallowed":{"type":"boolean"}}},"KashFlow.Accounting.Model.BillingAddress":{"type":"object","properties":{"Line1":{"type":"string"},"Line2":{"type":"string"},"Line3":{"type":"string"},"Line4":{"type":"string"},"PostCode":{"type":"string"},"CountryName":{"type":"string"},"CountryCode":{"type":"string"},"CountryId":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.DTO.Invoice.InvoiceRequest":{"required":["IssuedDate","CustomerCode"],"type":"object","properties":{"Number":{"format":"int32","type":"integer"},"IssuedDate":{"type":"string"},"DueDate":{"type":"string"},"PaidDate":{"type":"string"},"LineItems":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Invoice.InvoiceLineItemBase"}},"PaymentLines":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Invoice.InvoicePaymentItemRequest"}},"Address":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Request.BillingAddressRequest"},"DeliveryAddress":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Request.DeliveryAddressRequest"},"Currency":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Request.CurrencyRequest"},"UpdateCustomerAddress":{"type":"boolean"},"UpdateCustomerDeliveryAddress":{"type":"boolean"},"UseCustomDeliveryAddress":{"type":"boolean"},"Id":{"format":"int32","type":"integer"},"ProjectNumber":{"format":"int32","type":"integer"},"IsCISReverseCharge":{"type":"boolean"},"CustomerCode":{"type":"string"},"CustomerReference":{"type":"string"},"AutomaticCreditControlEnabled":{"type":"boolean"},"CustomerKey":{"type":"string"}}},"KashFlow.Accounting.DTO.Invoice.InvoiceLineItemBase":{"type":"object","properties":{"HomeCurrencyRate":{"format":"double","type":"number"},"HomeCurrencyVATAmount":{"format":"double","type":"number"},"ProjectNumber":{"format":"int32","type":"integer"},"ApplyTax1":{"type":"boolean"},"ApplyTax2":{"type":"boolean"},"ApplyTax3":{"type":"boolean"},"ApplyTax4":{"type":"boolean"},"ApplyTax5":{"type":"boolean"},"Number":{"format":"int32","type":"integer"},"Description":{"type":"string"},"Quantity":{"format":"double","type":"number"},"Rate":{"format":"double","type":"number"},"VATLevel":{"format":"double","type":"number"},"VATExempt":{"type":"boolean"},"VATAmount":{"format":"double","type":"number"},"NominalCode":{"format":"int32","type":"integer"},"ProductCode":{"type":"string"},"TaxCode":{"type":"string"},"Disallowed":{"type":"boolean"}}},"KashFlow.Accounting.DTO.Invoice.InvoicePaymentItemRequest":{"type":"object","properties":{"Id":{"format":"int64","type":"integer"},"Date":{"type":"string"},"IsExternalRefund":{"type":"boolean"},"BFSTransactionId":{"format":"int64","type":"integer"},"BulkId":{"format":"int32","type":"integer"},"Reference":{"type":"string"},"PaymentProcessor":{"format":"int32","description":" 0 = NoCardPayments,  1 = SecureHosting,  2 = SagePay,  3 = IridiumCorp,  4 = Worldpay,  5 = ProcessingPoint,  6 = SagePaymentSolutions,  7 = SmartPay,  8 = AuthorizeDotNet,  9 = PayPalPro,  10 = PaymentSense,  11 = CardSave,  12 = CardStream,  14 = BarclayCardEPdq,  15 = GoCardless,  16 = McpePayPoint,  17 = GlobalPayments,  18 = EWayPayment,  19 = Stripe,  20 = BarclayCardEPdqExtraPlus,  21 = Square","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,14,15,16,17,18,19,20,21],"type":"integer"},"ResetBankReconciliation":{"type":"boolean"},"AccountId":{"format":"int32","type":"integer"},"Note":{"type":"string"},"Method":{"format":"int64","type":"integer"},"Amount":{"format":"double","type":"number"}}},"KashFlow.Accounting.DTO.Request.BillingAddressRequest":{"type":"object","properties":{"CountryName":{"type":"string"},"CountryCode":{"type":"string"},"Line1":{"type":"string"},"Line2":{"type":"string"},"Line3":{"type":"string"},"Line4":{"type":"string"},"PostCode":{"type":"string"}}},"KashFlow.Accounting.DTO.Request.CurrencyRequest":{"required":["Code"],"type":"object","properties":{"Code":{"type":"string"},"ExchangeRate":{"format":"double","type":"number"}}},"KashFlow.Accounting.DTO.Invoice.InvoiceResponse":{"required":["IssuedDate","CustomerCode"],"type":"object","properties":{"Number":{"format":"int32","type":"integer"},"IssuedDate":{"type":"string"},"DueDate":{"type":"string"},"PaidDate":{"type":"string"},"Address":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Response.AddressResponse"},"DeliveryAddress":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Response.DeliveryAddressResponse"},"LineItems":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Invoice.InvoiceLineItemResponse"}},"PaymentLines":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Invoice.InvoicePaymentItemResponse"}},"ReminderLetters":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Invoice.ReminderLetterResponse"}},"LastPaymentDate":{"type":"string"},"CISRCNetAmount":{"format":"double","type":"number"},"CISRCVatAmount":{"format":"double","type":"number"},"HomeCurrencyVATAmount":{"format":"double","type":"number"},"IsCISReverseCharge":{"type":"boolean"},"VATNumber":{"type":"string"},"CustomerDiscount":{"format":"double","type":"number"},"CustomerContactName":{"type":"string"},"CustomerContactFirstName":{"type":"string"},"CustomerContactLastName":{"type":"string"},"Currency":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Response.CurrencyResponse"},"Permalink":{"type":"string"},"PackingSlipPermalink":{"type":"string"},"IsWhtDeductionToBeApplied":{"type":"boolean"},"FormattedDueAmount":{"type":"string"},"PreviousNumber":{"format":"int32","type":"integer"},"NextNumber":{"format":"int32","type":"integer"},"UseCustomDeliveryAddress":{"type":"boolean"},"CreatedDate":{"format":"date-time","type":"string"},"VATAmount":{"format":"double","type":"number"},"NetAmount":{"format":"double","type":"number"},"TotalPaidAmount":{"format":"double","type":"number"},"GrossAmount":{"format":"double","type":"number"},"Status":{"type":"string"},"HomeCurrencyGrossAmount":{"format":"double","type":"number"},"ProjectGrossAmount":{"format":"double","type":"number"},"CustomerName":{"type":"string"},"CustomerId":{"format":"int32","type":"integer"},"EmailCount":{"format":"int32","type":"integer"},"OverdueDays":{"format":"int32","type":"integer"},"DueAmount":{"format":"double","type":"number"},"ProjectName":{"type":"string"},"FileCount":{"format":"int32","type":"integer"},"VATReturnId":{"format":"int64","type":"integer"},"Type":{"type":"string"},"TradeBorderType":{"type":"string"},"IsArchived":{"type":"boolean"},"Id":{"format":"int32","type":"integer"},"ProjectNumber":{"format":"int32","type":"integer"},"CustomerCode":{"type":"string"},"CustomerReference":{"type":"string"},"AutomaticCreditControlEnabled":{"type":"boolean"},"CustomerKey":{"type":"string"}}},"KashFlow.Accounting.DTO.Invoice.InvoiceLineItemResponse":{"type":"object","properties":{"NominalId":{"format":"int32","type":"integer"},"ProductName":{"type":"string"},"NominalName":{"type":"string"},"ProjectName":{"type":"string"},"Tax1Amount":{"format":"double","type":"number"},"Tax2Amount":{"format":"double","type":"number"},"Tax3Amount":{"format":"double","type":"number"},"Tax4Amount":{"format":"double","type":"number"},"Tax5Amount":{"format":"double","type":"number"},"DisableDisallowed":{"type":"boolean"},"HomeCurrencyRate":{"format":"double","type":"number"},"HomeCurrencyVATAmount":{"format":"double","type":"number"},"ProjectNumber":{"format":"int32","type":"integer"},"ApplyTax1":{"type":"boolean"},"ApplyTax2":{"type":"boolean"},"ApplyTax3":{"type":"boolean"},"ApplyTax4":{"type":"boolean"},"ApplyTax5":{"type":"boolean"},"Number":{"format":"int32","type":"integer"},"Description":{"type":"string"},"Quantity":{"format":"double","type":"number"},"Rate":{"format":"double","type":"number"},"VATLevel":{"format":"double","type":"number"},"VATExempt":{"type":"boolean"},"VATAmount":{"format":"double","type":"number"},"NominalCode":{"format":"int32","type":"integer"},"ProductCode":{"type":"string"},"TaxCode":{"type":"string"},"Disallowed":{"type":"boolean"}}},"KashFlow.Accounting.DTO.Invoice.InvoicePaymentItemResponse":{"type":"object","properties":{"Id":{"format":"int64","type":"integer"},"Date":{"type":"string"},"BulkId":{"format":"int32","type":"integer"},"BFSTransactionId":{"format":"int64","type":"integer"},"BankTransactionId":{"format":"int64","type":"integer"},"Reference":{"type":"string"},"PaymentProcessor":{"format":"int32","description":" 0 = NoCardPayments,  1 = SecureHosting,  2 = SagePay,  3 = IridiumCorp,  4 = Worldpay,  5 = ProcessingPoint,  6 = SagePaymentSolutions,  7 = SmartPay,  8 = AuthorizeDotNet,  9 = PayPalPro,  10 = PaymentSense,  11 = CardSave,  12 = CardStream,  14 = BarclayCardEPdq,  15 = GoCardless,  16 = McpePayPoint,  17 = GlobalPayments,  18 = EWayPayment,  19 = Stripe,  20 = BarclayCardEPdqExtraPlus,  21 = Square","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,14,15,16,17,18,19,20,21],"type":"integer"},"BulkPaymentNumber":{"format":"int32","type":"integer"},"Permalink":{"type":"string"},"PaymentProcessorEnumValue":{"format":"int32","description":" 0 = NoCardPayments,  1 = SecureHosting,  2 = SagePay,  3 = IridiumCorp,  4 = Worldpay,  5 = ProcessingPoint,  6 = SagePaymentSolutions,  7 = SmartPay,  8 = AuthorizeDotNet,  9 = PayPalPro,  10 = PaymentSense,  11 = CardSave,  12 = CardStream,  14 = BarclayCardEPdq,  15 = GoCardless,  16 = McpePayPoint,  17 = GlobalPayments,  18 = EWayPayment,  19 = Stripe,  20 = BarclayCardEPdqExtraPlus,  21 = Square","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,14,15,16,17,18,19,20,21],"type":"integer"},"VATReturnId":{"format":"int64","type":"integer"},"IsPaymentCreditNote":{"type":"boolean"},"BankReconciliationId":{"format":"int32","type":"integer"},"AccountId":{"format":"int32","type":"integer"},"Note":{"type":"string"},"Method":{"format":"int64","type":"integer"},"Amount":{"format":"double","type":"number"}}},"KashFlow.Accounting.DTO.Invoice.ReminderLetterResponse":{"type":"object","properties":{"Number":{"format":"int32","type":"integer"},"IsSent":{"type":"boolean"}}},"KashFlow.Accounting.Model.InvoiceSummary":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Number":{"format":"int32","type":"integer"},"DueAmount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.QuoteAndConvertedInvoiceNumber":{"type":"object","properties":{"QuoteNumber":{"format":"int32","type":"integer"},"InvoiceNumber":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.ITSA.AnnualSummaryResponse":{"type":"object","properties":{"Adjustments":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.AnnualSummaryCommonData"}},"Allowances":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.AnnualSummaryCommonData"}},"NonFinancials":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.NonFinancialsResponseData"},"CorrelationId":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.AnnualSummaryCommonData":{"type":"object","properties":{"Name":{"type":"string"},"Description":{"type":"string"},"Value":{"format":"double","type":"number"},"BuildingDetails":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.AnnualSummaryBuildingDetails"}}}},"KashFlow.Accounting.Model.ITSA.NonFinancialsResponseData":{"type":"object","properties":{"BusniessDetailsChangedRecently":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.AnnualSummaryStringCommonData"},"Class4NicsExemptionReason":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.AnnualSummaryStringCommonData"},"IsExempt":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.AnnualSummaryStringCommonData"}}},"KashFlow.Accounting.Model.ITSA.AnnualSummaryBuildingDetails":{"type":"object","properties":{"Amount":{"format":"double","type":"number"},"FirstYear":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.FirstYear"},"Building":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Building"}}},"KashFlow.Accounting.Model.ITSA.AnnualSummaryStringCommonData":{"type":"object","properties":{"Name":{"type":"string"},"Description":{"type":"string"},"Value":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.FirstYear":{"type":"object","properties":{"QualifyingDate":{"type":"string"},"QualifyingAmountExpenditure":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Building":{"type":"object","properties":{"Name":{"type":"string"},"Number":{"type":"string"},"Postcode":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.AnnualSummaryRequest":{"type":"object","properties":{"adjustments":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Adjustments"},"allowances":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Allowances"},"nonFinancials":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.NonFinancials"}}},"KashFlow.Accounting.Model.ITSA.Adjustments":{"type":"object","properties":{"includedNonTaxableProfits":{"format":"double","type":"number"},"basisAdjustment":{"format":"double","type":"number"},"overlapReliefUsed":{"format":"double","type":"number"},"accountingAdjustment":{"format":"double","type":"number"},"outstandingBusinessIncome":{"format":"double","type":"number"},"balancingChargeBpra":{"format":"double","type":"number"},"balancingChargeOther":{"format":"double","type":"number"},"goodsAndServicesOwnUse":{"format":"double","type":"number"},"transitionProfitAmount":{"format":"double","type":"number"},"transitionProfitAccelerationAmount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Allowances":{"type":"object","properties":{"annualInvestmentAllowance":{"format":"double","type":"number"},"businessPremisesRenovationAllowance":{"format":"double","type":"number"},"capitalAllowanceMainPool":{"format":"double","type":"number"},"capitalAllowanceSpecialRatePool":{"format":"double","type":"number"},"zeroEmissionsGoodsVehicleAllowance":{"format":"double","type":"number"},"enhancedCapitalAllowance":{"format":"double","type":"number"},"allowanceOnSales":{"format":"double","type":"number"},"capitalAllowanceSingleAssetPool":{"format":"double","type":"number"},"tradingIncomeAllowance":{"format":"double","type":"number"},"electricChargePointAllowance":{"format":"double","type":"number"},"structuredBuildingAllowance":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.AnnualSummaryBuildingDetails"}},"enhancedStructuredBuildingAllowance":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.AnnualSummaryBuildingDetails"}},"zeroEmissionsCarAllowance":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.NonFinancials":{"type":"object","properties":{"businessDetailsChangedRecently":{"type":"boolean"},"class4NicsExemptionReason":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.BusinessRequest":{"type":"object","properties":{"businessPostcode":{"type":"string"},"accountingPeriod":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.AccountingPeriod"},"tradingName":{"type":"string"},"businessAddressLineOne":{"type":"string"},"businessAddressLineTwo":{"type":"string"},"businessAddressLineThree":{"type":"string"},"businessAddressLineFour":{"type":"string"},"businessAddressCountryCode":{"type":"string"},"commencementDate":{"type":"string"},"businessAddressCountryName":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.AccountingPeriod":{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"},"quarterlyPeriodType":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.ITSA.PartBusinessResponse":{"type":"object","properties":{"tradingName":{"type":"string"},"businessId":{"type":"string"},"typeOfBusiness":{"type":"string"},"links":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Link"}}}},"KashFlow.Accounting.Model.ITSA.Link":{"type":"object","properties":{"href":{"type":"string"},"method":{"type":"string"},"rel":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.BusinessResponse":{"type":"object","properties":{"businessAddressPostcode":{"type":"string"},"businessId":{"type":"string"},"typeOfBusiness":{"type":"string"},"cessationDate":{"type":"string"},"accountingPeriods":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.AccountingPeriod"}},"quarterlyTypeChoice":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.QuarterlyTypeChoice"},"tradingName":{"type":"string"},"businessAddressLineOne":{"type":"string"},"businessAddressLineTwo":{"type":"string"},"businessAddressLineThree":{"type":"string"},"businessAddressLineFour":{"type":"string"},"businessAddressCountryCode":{"type":"string"},"commencementDate":{"type":"string"},"businessAddressCountryName":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.QuarterlyTypeChoice":{"type":"object","properties":{"quarterlyPeriodType":{"type":"string"},"taxYearOfChoice":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.ITSABusinessIncomeSourceSummaryResponse":{"type":"object","properties":{"total":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.NameValueAndDescriptionData"}},"profit":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.NameValueAndDescriptionData"}},"loss":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.NameValueAndDescriptionData"}},"CorrelationId":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.NameValueAndDescriptionData":{"type":"object","properties":{"Name":{"type":"string"},"Description":{"type":"string"},"Value":{"format":"double","type":"number"},"KFValue":{"format":"double","type":"number"}}},"KashFlow.Accounting.DTO.VatMossReturn.ErrorResponse":{"type":"object","properties":{"VatMossErrors":{"$ref":"#/definitions/KashFlow.Accounting.DTO.VatMossReturn.VatMossErrors"},"Message":{"type":"string"},"Error":{"type":"string"}}},"KashFlow.Accounting.DTO.VatMossReturn.VatMossErrors":{"type":"object","properties":{"InvoicesWithVATNotSet":{"type":"array","items":{"format":"int32","type":"integer"}},"InvoicesWithInvalidVATRate":{"type":"array","items":{"format":"int32","type":"integer"}},"ExceedsLimitOfRecords":{"type":"boolean"}}},"KashFlow.Accounting.Model.ITSA.SelfEmploymentBusinessSourceAdjustableSummaryResponse":{"type":"object","properties":{"metadata":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.BusinessSourceAdjustableSummaryMetadata"},"businessIncomeSourceSummary":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.ITSABusinessIncomeSourceSummaryResponse"},"businessSourceAdjustableSummary":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.BusinessSourceAdjustableSummarySelfEmployment"},"zeroAdjustments":{"type":"boolean"},"links":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Link"}},"CorrelationId":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.BusinessSourceAdjustableSummaryMetadata":{"type":"object","properties":{"calculationId":{"type":"string"},"requestedDateTime":{"type":"string"},"adjustedDateTime":{"type":"string"},"nino":{"type":"string"},"taxYear":{"type":"string"},"summaryStatus":{"type":"string"},"adjustedSummary":{"type":"boolean"}}},"KashFlow.Accounting.Model.ITSA.BusinessSourceAdjustableSummarySelfEmployment":{"type":"object","properties":{"incomeBreakdown":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.BSASIncomeExpensesData"}},"expensesBreakdown":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.BSASIncomeExpensesData"}},"additionsBreakdown":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.BSASIncomeExpensesData"}}}},"KashFlow.Accounting.Model.ITSA.BSASIncomeExpensesData":{"type":"object","properties":{"BoxNumber":{"format":"double","type":"number"},"Comment":{"type":"string"},"Amount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.SelfEmploymentBusinessSourceAdjustableSummaryAdjustmentResponse":{"type":"object","properties":{"metadata":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.BusinessSourceAdjustableSummaryMetadata"},"adjustments":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.BusinessSourceAdjustableSummaryAdjustmentsSelfEmployment"},"links":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Link"}},"CorrelationId":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.BusinessSourceAdjustableSummaryAdjustmentsSelfEmployment":{"type":"object","properties":{"income":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.BSASIncomeExpensesData"}},"expenses":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.BSASIncomeExpensesData"}},"additions":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.BSASIncomeExpensesData"}}}},"KashFlow.Accounting.Model.ITSA.BSASSelfEmploymentAdjustment":{"type":"object","properties":{"income":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.BSASSelfEmploymentIncomeBreakdown"},"expenses":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.BSASSelfEmploymentAdjustmentExpenses"},"additions":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.SubmitBSASSelfEmploymentAdditionsBreakdown"},"zeroAdjustments":{"type":"boolean"}}},"KashFlow.Accounting.Model.ITSA.BSASSelfEmploymentIncomeBreakdown":{"type":"object","properties":{"turnover":{"format":"double","type":"number"},"other":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.BSASSelfEmploymentAdjustmentExpenses":{"type":"object","properties":{"consolidatedExpenses":{"format":"double","type":"number"},"costOfGoods":{"format":"double","type":"number"},"paymentsToSubcontractors":{"format":"double","type":"number"},"wagesAndStaffCosts":{"format":"double","type":"number"},"carVanTravelExpenses":{"format":"double","type":"number"},"premisesRunningCosts":{"format":"double","type":"number"},"maintenanceCosts":{"format":"double","type":"number"},"adminCosts":{"format":"double","type":"number"},"advertisingCosts":{"format":"double","type":"number"},"businessEntertainmentCosts":{"format":"double","type":"number"},"interestOnBankOtherLoans":{"format":"double","type":"number"},"financeCharges":{"format":"double","type":"number"},"irrecoverableDebtse":{"format":"double","type":"number"},"professionalFees":{"format":"double","type":"number"},"depreciation":{"format":"double","type":"number"},"otherExpenses":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.SubmitBSASSelfEmploymentAdditionsBreakdown":{"type":"object","properties":{"costOfGoodsDisallowable":{"format":"double","type":"number"},"paymentsToSubcontractorsDisallowable":{"format":"double","type":"number"},"wagesAndStaffCostsDisallowable":{"format":"double","type":"number"},"carVanTravelExpensesDisallowable":{"format":"double","type":"number"},"premisesRunningCostsDisallowable":{"format":"double","type":"number"},"maintenanceCostsDisallowable":{"format":"double","type":"number"},"adminCostsDisallowable":{"format":"double","type":"number"},"advertisingCostsDisallowable":{"format":"double","type":"number"},"businessEntertainmentCostsDisallowable":{"format":"double","type":"number"},"interestOnBankOtherLoansDisallowable":{"format":"double","type":"number"},"financeChargesDisallowable":{"format":"double","type":"number"},"irrecoverableDebtsDisallowable":{"format":"double","type":"number"},"professionalFeesDisallowable":{"format":"double","type":"number"},"depreciationDisallowable":{"format":"double","type":"number"},"otherExpensesDisallowable":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.BSASSelfEmploymentAdjustmentResponse":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Link"}}}},"KashFlow.Accounting.Model.ITSA.BSASListResponse":{"type":"object","properties":{"businessSources":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.BusinessSourcesList"}},"CorrelationId":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.BusinessSourcesList":{"type":"object","properties":{"typeOfBusiness":{"type":"string"},"businessId":{"type":"string"},"accountingPeriod":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.BusinessSourceAdjustmentSummaryAccountingPeriod"},"taxYear":{"type":"string"},"summaries":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.BSASSummaries"}}}},"KashFlow.Accounting.Model.ITSA.BusinessSourceAdjustmentSummaryAccountingPeriod":{"type":"object","properties":{"startDate":{"type":"string"},"endDate":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.BSASSummaries":{"type":"object","properties":{"calculationId":{"type":"string"},"requestedDateTime":{"type":"string"},"summaryStatus":{"type":"string"},"adjustedSummary":{"type":"boolean"}}},"KashFlow.Accounting.Model.ITSA.SelfEmploymentBusinessSourceAdjustableSummaryDetail":{"type":"object","properties":{"businessIncomeSourceSummary":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.ITSABusinessIncomeSourceSummaryResponse"},"incomeBreakdown":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.BSASIncomeExpensesDetailData"}},"expensesBreakdown":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.BSASIncomeExpensesDetailData"}},"additionsBreakdown":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.BSASIncomeExpensesDetailData"}},"zeroAdjustments":{"type":"boolean"},"metadata":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.BusinessSourceAdjustableSummaryMetadata"}}},"KashFlow.Accounting.Model.ITSA.BSASIncomeExpensesDetailData":{"type":"object","properties":{"CurrentAmount":{"format":"double","type":"number"},"AdjustedAmount":{"format":"double","type":"number"},"Nominals":{"type":"array","items":{"format":"int32","type":"integer"}},"BoxNumber":{"format":"double","type":"number"},"Comment":{"type":"string"},"Amount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.IndividualLosses.LossClaimResponse":{"type":"object","properties":{"TaxYearClaimedFor":{"type":"string"},"TypeOfLoss":{"type":"string"},"TypeOfClaim":{"type":"string"},"BusinessId":{"type":"string"},"Sequence":{"format":"int32","type":"integer"},"LastModified":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.IndividualLosses.ListLossClaimResponse":{"type":"object","properties":{"ClaimId":{"type":"string"},"TaxYearClaimedFor":{"type":"string"},"TypeOfLoss":{"type":"string"},"TypeOfClaim":{"type":"string"},"BusinessId":{"type":"string"},"Sequence":{"format":"int32","type":"integer"},"LastModified":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.IndividualLosses.AmendLossClaimsOrderRequest":{"type":"object","properties":{"typeOfClaim":{"type":"string"},"listOfLossClaims":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.IndividualLosses.LossClaims"}}}},"KashFlow.Accounting.Model.ITSA.IndividualLosses.LossClaims":{"type":"object","properties":{"claimId":{"type":"string"},"sequence":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.ITSA.IndividualLosses.BroughtForwardLossClaimResponse":{"type":"object","properties":{"BusinessId":{"type":"string"},"TypeOfLoss":{"type":"string"},"LossAmount":{"format":"double","type":"number"},"TaxYearBroughtForwardFrom":{"type":"string"},"LastModified":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.IndividualLosses.ListBroughtForwardLossClaim":{"type":"object","properties":{"LossId":{"type":"string"},"BusinessId":{"type":"string"},"TypeOfLoss":{"type":"string"},"LossAmount":{"format":"double","type":"number"},"TaxYearBroughtForwardFrom":{"type":"string"},"LastModified":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.Periods.LateAccountingDateRuleResponse":{"type":"object","properties":{"disapply":{"type":"boolean"},"eligible":{"type":"boolean"},"taxYearOfElection":{"type":"string"},"taxYearElectionExpires":{"type":"string"}}},"KashFlow.Accounting.RestApi.Parameters.ITSATaxCalculationFilterParameters":{"type":"object","properties":{"Page":{"format":"int32","description":"Page number. (default is 1)","type":"integer"},"PerPage":{"format":"int32","description":"PerPage is number of records per page. (default is 10)","type":"integer"},"Order":{"description":"Sorting order (asc or desc) (default is desc)","type":"string"},"FromDate":{"description":"For from date filter eg. Format (yyyy-mm-dd)","type":"string"},"ToDate":{"description":"For to date filter eg. Format (yyyy-mm-dd)","type":"string"},"SortBy":{"format":"int32","description":"Sort By column/field name. (default is TaxCalculationCreatedAt) 0 = TaxCalculationCreatedAt,  1 = Type,  2 = RequestedBy,  3 = User,  4 = TaxCalculationStatus","enum":[0,1,2,3,4],"type":"integer"},"Type":{"format":"int32","description":"Tax calculation Type 0 = InYear,  1 = FinalDeclaration,  2 = Crystallisation,  3 = All,  4 = IntentToAmend,  5 = IntentToFinalise","enum":[0,1,2,3,4,5],"type":"integer"},"Status":{"format":"int32","description":"Tax Calculation Status 0 = Blank,  1 = Success,  2 = Partial,  3 = Failed,  4 = InProgress,  -1 = All","enum":[0,1,2,3,4,-1],"type":"integer"},"TaxCalculationCreatedAt":{"description":"ITSATaxCalculationCreatedAt  Format (yyyy-mm-dd)","type":"string"},"RequestedBy":{"format":"int32","description":"Tax Calculation RequestedBy 0 = Customer,  1 = Agent,  2 = HMRC,  -1 = All","enum":[0,1,2,-1],"type":"integer"}}},"KashFlow.Accounting.Model.Paging[KashFlow.Accounting.Model.ITSA.ITSATaxCalculationForList]":{"required":["Data"],"type":"object","properties":{"MetaData":{"$ref":"#/definitions/KashFlow.Accounting.Model.PagingMetadata"},"Data":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.ITSATaxCalculationForList"}}}},"KashFlow.Accounting.Model.ITSA.ITSATaxCalculationForList":{"type":"object","properties":{"CorrelationId":{"type":"string"},"TaxYear":{"type":"string"},"RequestedBy":{"type":"string"},"Type":{"type":"string"},"MetaDataFlag":{"type":"boolean"},"UserName":{"type":"string"},"TaxYearCreatedAt":{"type":"string"},"RowNumber":{"format":"int32","type":"integer"},"TotalIncomeTaxAndNicsDue":{"format":"double","type":"number"},"Nino":{"type":"string"},"BusinessId":{"type":"string"},"CalculationId":{"type":"string"},"TaxCalculationStatus":{"type":"string"}}},"KashFlow.Accounting.RestApi.Parameters.ITSA.ITSASubmissionLogFilterParameters":{"type":"object","properties":{"Page":{"format":"int32","description":"Page number. (default is 1)","type":"integer"},"PerPage":{"format":"int32","description":"PerPage is number of records per page. (default is 10)","type":"integer"},"Order":{"description":"Sorting order (asc or desc) (default is desc)","type":"string"},"SortBy":{"format":"int32","description":"Sort By column/field name. (default is SubmissionTimeStamp) 0 = SubmissionTimeStamp,  1 = SubmisionFromDate,  2 = SubmissionToDate,  3 = SubmissionType,  4 = RequestedBy,  5 = SubmissionLogStatus","enum":[0,1,2,3,4,5],"type":"integer"},"LogDateType":{"format":"int32","description":"Date type (Default is SubmissionDate) 0 = All,  1 = SubmissionDate,  2 = SubmissionPeriodDate","enum":[0,1,2],"type":"integer"},"FromDate":{"description":"Submission From Date","type":"string"},"ToDate":{"description":"Submission To Date","type":"string"},"Type":{"format":"int32","description":"Type of submission 0 = All,  1 = PeriodicUpdate,  2 = AdjustmentAndAllowances,  3 = EOPS,  4 = Crystallization,  5 = BSAS","enum":[0,1,2,3,4,5],"type":"integer"},"RequestedBy":{"format":"int32","description":"Submission Requested By 0 = All,  1 = Customer,  2 = Agent","enum":[0,1,2],"type":"integer"},"Status":{"format":"int32","description":"Status 0 = All,  2 = Failed,  3 = Successful","enum":[0,2,3],"type":"integer"}}},"KashFlow.Accounting.Model.Paging[KashFlow.Accounting.Model.ITSA.ITSASubmissionLogForList]":{"required":["Data"],"type":"object","properties":{"MetaData":{"$ref":"#/definitions/KashFlow.Accounting.Model.PagingMetadata"},"Data":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.ITSASubmissionLogForList"}}}},"KashFlow.Accounting.Model.ITSA.ITSASubmissionLogForList":{"type":"object","properties":{"UserName":{"type":"string"},"Nino":{"type":"string"},"Type":{"type":"string"},"SubmittedBy":{"type":"string"},"FromDate":{"type":"string"},"ToDate":{"type":"string"},"SubmissionTimeStamp":{"type":"string"},"Status":{"type":"string"},"CorrelationId":{"type":"string"},"RowNumber":{"format":"int32","type":"integer"},"ErrorMessage":{"type":"string"}}},"KashFlow.Accounting.RestApi.Parameters.ITSA.ITSABSASLogFilterParameters":{"type":"object","properties":{"Page":{"format":"int32","description":"Page number. (default is 1)","type":"integer"},"PerPage":{"format":"int32","description":"PerPage is number of records per page. (default is 10)","type":"integer"},"Order":{"description":"Sorting order (asc or desc) (default is desc)","type":"string"},"SortBy":{"format":"int32","description":"Sort By column/field name. (default is RequestedTimeStamp) 0 = RequestedTimeStamp,  1 = RequestedBy,  2 = RequestedUser,  3 = Status,  4 = IsAdjusted","enum":[0,1,2,3,4],"type":"integer"},"SummaryStatus":{"format":"int32","description":"BSAS summary status 0 = Blank,  1 = Valid,  2 = Invalid,  3 = Superseded,  -1 = All","enum":[0,1,2,3,-1],"type":"integer"},"RequestedBy":{"format":"int32","description":"BSAS log Requested By 0 = All,  1 = Customer,  2 = Agent","enum":[0,1,2],"type":"integer"},"IsAdjusted":{"format":"int32","description":"BSAS log Requested By 0 = False,  1 = True,  -1 = All","enum":[0,1,-1],"type":"integer"}}},"KashFlow.Accounting.Model.Paging[KashFlow.Accounting.Model.ITSA.BSASLogsList]":{"required":["Data"],"type":"object","properties":{"MetaData":{"$ref":"#/definitions/KashFlow.Accounting.Model.PagingMetadata"},"Data":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.BSASLogsList"}}}},"KashFlow.Accounting.Model.ITSA.BSASLogsList":{"type":"object","properties":{"Nino":{"type":"string"},"BusinessId":{"type":"string"},"RequestedDateTime":{"type":"string"},"BSASId":{"type":"string"},"SummaryStatus":{"type":"string"},"IsAdjusted":{"type":"boolean"},"RequestedBy":{"type":"string"},"UserName":{"type":"string"},"CorrelationId":{"type":"string"},"RowNumber":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.ITSA.ITSANotification":{"type":"object","properties":{"NotificationType":{"type":"string"},"NotificationText":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.IncomeAndExpenditureObligationRequest":{"type":"object","properties":{"FromDate":{"type":"string"},"ToDate":{"type":"string"},"WithPeriods":{"type":"boolean"},"RefreshFlag":{"type":"boolean"},"IsDeleteAndRecreate":{"type":"boolean"}}},"KashFlow.Accounting.Model.ITSA.IncomeAndExpenditureObligationResponse":{"type":"object","properties":{"Data":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.IncomeAndExpenditureObligations"}},"Metadata":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.ObligationMetadata"}}},"KashFlow.Accounting.Model.ITSA.IncomeAndExpenditureObligations":{"type":"object","properties":{"obligations":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.IncomeAndExpenditureObligationBase"}}}},"KashFlow.Accounting.Model.ITSA.ObligationMetadata":{"type":"object","properties":{"PeriodToBeSubmittedStartDate":{"type":"string"},"PeriodToBeSubmittedEndDate":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.IncomeAndExpenditureObligationBase":{"type":"object","properties":{"typeOfBusiness":{"type":"string"},"businessId":{"type":"string"},"obligationDetails":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.IncomeAndExpenditureObligationDetails"}}}},"KashFlow.Accounting.Model.ITSA.IncomeAndExpenditureObligationDetails":{"type":"object","properties":{"periods":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.PeriodResponse"}},"periodStartDate":{"type":"string"},"periodEndDate":{"type":"string"},"dueDate":{"type":"string"},"receivedDate":{"type":"string"},"status":{"type":"string"},"CorrelationId":{"type":"string"},"HMRCStatus":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.PeriodResponse":{"type":"object","properties":{"PeriodKeyFromHMRC":{"type":"string"},"status":{"type":"string"},"SubmittedDate":{"type":"string"},"ErrorMessage":{"type":"string"},"CreatedDate":{"format":"date-time","type":"string"},"StartDate":{"type":"string"},"EndDate":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.CrystallizationObligationsResponse":{"type":"object","properties":{"Data":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.CrystallisationObligationDetails"},"Metadata":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.ObligationMetadata"}}},"KashFlow.Accounting.Model.ITSA.CrystallisationObligationDetails":{"type":"object","properties":{"obligations":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.CrystallisationObligation"}}}},"KashFlow.Accounting.Model.ITSA.CrystallisationObligation":{"type":"object","properties":{"ErrorMessage":{"type":"string"},"periodStartDate":{"type":"string"},"periodEndDate":{"type":"string"},"dueDate":{"type":"string"},"receivedDate":{"type":"string"},"status":{"type":"string"},"CorrelationId":{"type":"string"},"HMRCStatus":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.SubmitCrystallizationResponse":{"type":"object","properties":{"CorrelationId":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.AllowanceAndAdjustmentObligation":{"type":"object","properties":{"ErrorMessage":{"type":"string"},"periodStartDate":{"type":"string"},"periodEndDate":{"type":"string"},"dueDate":{"type":"string"},"receivedDate":{"type":"string"},"status":{"type":"string"},"CorrelationId":{"type":"string"},"HMRCStatus":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.Periods.CreatePeriodsRequest":{"type":"object","properties":{"AccountingPeriodId":{"format":"int32","type":"integer"},"PeriodStartDate":{"type":"string"},"PeriodEndDate":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.AccountingPeriodParameters":{"type":"object","properties":{"accountingPeriodId":{"format":"int32","type":"integer"},"startDate":{"type":"string"},"endDate":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.UpsertPeriodResponse":{"type":"object","properties":{"periods":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Period"}},"links":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Link"}}}},"KashFlow.Accounting.Model.ITSA.Period":{"type":"object","properties":{"periodId":{"type":"string"},"periodStartDate":{"type":"string"},"periodEndDate":{"type":"string"},"links":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Link"}}}},"KashFlow.Accounting.Model.ITSA.Periods.AccountingTypeResponse":{"type":"object","properties":{"AccountingType":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.PeriodicUpdateParameters":{"type":"object","properties":{"PeriodKey":{"type":"string"},"StartDate":{"type":"string"},"EndDate":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.PeriodicUpdateResponse":{"type":"object","properties":{"periodDates":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Dates"},"periodIncome":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.PeriodIncome"},"periodExpenses":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.PeriodExpenses"},"periodDisallowableExpenses":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.PeriodDisallowableExpenses"},"links":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Link"}}}},"KashFlow.Accounting.Model.ITSA.Dates":{"type":"object","properties":{"periodStartDate":{"type":"string"},"periodEndDate":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.PeriodIncome":{"type":"object","properties":{"turnover":{"format":"double","type":"number"},"other":{"format":"double","type":"number"},"taxTakenOffTradingIncome":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.PeriodExpenses":{"type":"object","properties":{"costOfGoods":{"format":"double","type":"number"},"paymentsToSubcontractors":{"format":"double","type":"number"},"wagesAndStaffCosts":{"format":"double","type":"number"},"carVanTravelExpenses":{"format":"double","type":"number"},"premisesRunningCosts":{"format":"double","type":"number"},"maintenanceCosts":{"format":"double","type":"number"},"adminCosts":{"format":"double","type":"number"},"advertisingCosts":{"format":"double","type":"number"},"businessEntertainmentCosts":{"format":"double","type":"number"},"interestOnBankOtherLoans":{"format":"double","type":"number"},"financeCharges":{"format":"double","type":"number"},"irrecoverableDebts":{"format":"double","type":"number"},"professionalFees":{"format":"double","type":"number"},"depreciation":{"format":"double","type":"number"},"otherExpenses":{"format":"double","type":"number"},"consolidatedExpenses":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.PeriodDisallowableExpenses":{"type":"object","properties":{"costOfGoodsDisallowable":{"format":"double","type":"number"},"paymentsToSubcontractorsDisallowable":{"format":"double","type":"number"},"wagesAndStaffCostsDisallowable":{"format":"double","type":"number"},"carVanTravelExpensesDisallowable":{"format":"double","type":"number"},"premisesRunningCostsDisallowable":{"format":"double","type":"number"},"maintenanceCostsDisallowable":{"format":"double","type":"number"},"adminCostsDisallowable":{"format":"double","type":"number"},"advertisingCostsDisallowable":{"format":"double","type":"number"},"businessEntertainmentCostsDisallowable":{"format":"double","type":"number"},"interestOnBankOtherLoansDisallowable":{"format":"double","type":"number"},"financeChargesDisallowable":{"format":"double","type":"number"},"irrecoverableDebtsDisallowable":{"format":"double","type":"number"},"professionalFeesDisallowable":{"format":"double","type":"number"},"depreciationDisallowable":{"format":"double","type":"number"},"otherExpensesDisallowable":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.PeriodicUpdate":{"type":"object","properties":{"periodDates":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Dates"},"periodIncome":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.PeriodIncome"},"periodExpenses":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.PeriodExpenses"},"periodDisallowableExpenses":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.PeriodDisallowableExpenses"}}},"KashFlow.Accounting.Model.ITSA.UpdatePeriodicUpdateResponse":{"type":"object","properties":{"links":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Link"}}}},"KashFlow.Accounting.Model.ITSA.Periods.RetrievePeriodsOfAccountResponse":{"type":"object","properties":{"submittedOn":{"type":"string"},"periodsOfAccount":{"type":"boolean"},"periodsOfAccountDates":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Periods.PeriodOfAccountDate"}}}},"KashFlow.Accounting.Model.ITSA.Periods.PeriodOfAccountDate":{"type":"object","properties":{"startDate":{"type":"string"},"endDate":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.Periods.CreateUpdatePeriodsOfAccountRequest":{"type":"object","properties":{"periodsOfAccount":{"type":"boolean"},"periodsOfAccountDates":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Periods.PeriodOfAccountDate"}}}},"KashFlow.Accounting.Model.ITSA.SettingRequest":{"type":"object","properties":{"IncomeType":{"type":"array","items":{"format":"int32","type":"integer"}},"BusinessId":{"type":"string"},"IsRegistered":{"type":"boolean"},"TaxName":{"type":"string"},"IsAnnualIncomeAboveThreshold":{"type":"boolean"},"IsSignupToMTD":{"type":"boolean"},"Frequency":{"type":"string"},"Nino":{"type":"string"},"DisplayMtdRecommendedModal":{"type":"boolean"},"DoConsolidatedIncomeAndExpenses":{"type":"boolean"},"IsSendEmail":{"type":"boolean"},"IsSendEmailToClient":{"type":"boolean"},"AccountingType":{"format":"int32","description":" 0 = CASH,  1 = ACCRUAL","enum":[0,1],"type":"integer"}}},"KashFlow.Accounting.Model.ITSA.SettingResponse":{"type":"object","properties":{"IncomeType":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.UserIncomeType"}},"AuthRefreshTokenExpired":{"type":"boolean"},"isBetaFlag":{"type":"boolean"},"IsConnectedToMtd":{"type":"boolean"},"Business":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.BusinessResponse"},"AccountingPeriod":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.AccountingPeriodResponse"}},"IncomeTaxSettingEnabled":{"type":"boolean"},"ErrorDetail":{"$ref":"#/definitions/KashFlow.Accounting.Model.VAT.ErrorDetail"},"ErrorCode":{"format":"int32","description":" 0 = FORMAT_NINO,  1 = UserIsNotItsaRegistered,  2 = ClientOrAgentNotAuthorized,  3 = BusinessId,  4 = ITSASettingsCanNotBeNull,  5 = TaxNameCharacterLimit,  6 = IncomeTypeErrorMessage,  7 = IncomeTypeCannotBeNull,  8 = LiveHMRCITSAAPICallsProhibitedForDemoUserAccount,  9 = MustHaveAccessToITSA,  10 = InvalidFrequency,  11 = NotYetConnectedToHMRC,  12 = BusinessIdMustNotBeBlank,  13 = BusinessIdExistsForAnotherUser,  14 = BusinessIdFormat,  15 = BusinessIdNotAssociatedWithKashflow,  16 = InvalidPartnerId,  17 = InvalidPostcode,  18 = InvalidAccountingPeriodStartDate,  19 = InvalidAccountingPeriodEndDate,  20 = InvalidAccountingType,  21 = InvalidCommencementDate,  22 = NinoIsNotAssociatedWithKashflowAccount,  23 = ClientOrAgentNotAuthorised,  24 = PartnerTokenWithoutClientTokenNotAuthorized,  25 = NoBusinessFound,  26 = MatchingResourceNotFound,  27 = TradingNameIsRequired,  28 = InvalidTradingName,  29 = AddressOneIsRequired,  30 = AddressTwoIsRequired,  31 = AddressThreeIsRequired,  32 = AddressFourIsRequired,  33 = InvalidAddressOne,  34 = businessAddressLineTwo,  35 = businessAddressLineThree,  36 = businessAddressLineFour,  37 = PostcodeRequired,  38 = CommencementDateRequired,  39 = InvalidCommensementDate,  40 = StartDateRequired,  41 = EndDateRequired,  42 = StartDateCanNotBeInPast,  43 = EndDateCanNotBeInPast,  44 = AccountingTypeRequired,  45 = InvalidCommencementDateFormat,  46 = InvalidStartDateFormat,  47 = InvalidEndDateFormat,  48 = InvalidDateFormat,  49 = EndDateGreaterThanStartDate,  50 = BusinessTypeInvalid,  51 = MISSING_FROM_DATE,  52 = MISSING_TO_DATE,  53 = InvalidFromAndToDate,  54 = DateRangeInvalid,  55 = BusinessTypeIsRequired,  56 = InvalidFromDateFormat,  57 = InvalidToDateFormat,  58 = RuleFromDateNotSupported,  59 = BusinessIdRequired,  60 = InvalidFromDate,  61 = NO_OBLIGATIONS_FOUND,  62 = FORMAT_TYPE_OF_BUSINESS,  63 = GenericHmrcError,  64 = AccountingPeriodDoesNotExists,  65 = PeriodicFrequencyNotCustom,  66 = StartDateGreaterthanEndate,  67 = MandatoryPeriodStartParametersMissing,  68 = MandatoryPeriodEndParametersMissing,  69 = FormatStartDate,  70 = FormatEndDate,  71 = RangeToDateBeforeFromDate,  72 = NoPeriods,  73 = OverlappingPeriod,  74 = NotContiguousPeriod,  75 = MisalignedPeriod,  76 = AccountingPeriodsNotAvailable,  77 = FORMAT_STATUS,  78 = RangeDateNotSupported,  79 = NoAccountingYear,  80 = MandatoryParametersMissing,  81 = NoObligationsForAccountingYear,  82 = NoPeriodsToCreate,  83 = NoPeriodsFound,  84 = PeriodAlreadyExists,  85 = ExpenseAndConsolidatedExist,  86 = InvalidMonetaryAmount,  87 = DisallowedGreaterThenAmount,  88 = FormatcalcId,  89 = TaxCalculationDetailsNotFound,  90 = NO_INCOMETAX_SELF_ASSESSMENT_ADDED,  91 = Consolidating_TaxCalculation_InProgress,  92 = DatesNotInValidAccountingYear,  93 = InvalidEndOfPeriodObligationStatus,  94 = AccountingYearIsNotAvailable,  95 = FormatCalculationId,  96 = BsasNotFound,  97 = UserMustSignUpToMtd,  98 = BusinessTypeNotSupported,  99 = AccountingPeriodNotFound,  100 = TaxCalculationNotTriggered,  101 = AccountingPeriodDateRangeInvalid","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101],"type":"integer"},"IsRegistered":{"type":"boolean"},"TaxName":{"type":"string"},"IsAnnualIncomeAboveThreshold":{"type":"boolean"},"IsSignupToMTD":{"type":"boolean"},"Frequency":{"type":"string"},"Nino":{"type":"string"},"DisplayMtdRecommendedModal":{"type":"boolean"},"DoConsolidatedIncomeAndExpenses":{"type":"boolean"},"IsSendEmail":{"type":"boolean"},"IsSendEmailToClient":{"type":"boolean"},"AccountingType":{"format":"int32","description":" 0 = CASH,  1 = ACCRUAL","enum":[0,1],"type":"integer"}}},"KashFlow.Accounting.Model.ITSA.UserIncomeType":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.ITSA.AccountingPeriodResponse":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"StartDate":{"format":"date-time","type":"string"},"EndDate":{"format":"date-time","type":"string"},"QuarterlyPeriodType":{"format":"int32","description":" 0 = standard,  1 = calendar","enum":[0,1],"type":"integer"},"IsCumulative":{"type":"boolean"},"AccountingType":{"format":"int32","description":" 0 = CASH,  1 = ACCRUAL","enum":[0,1],"type":"integer"}}},"KashFlow.Accounting.Model.VAT.ErrorDetail":{"type":"object","properties":{"Message":{"type":"string"},"Code":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.ITSATaxCalculationResponse":{"type":"object","properties":{"Response":{"type":"string"},"Status":{"type":"boolean"},"CalculationId":{"type":"string"},"CorrelationId":{"type":"string"},"TaxCalculation":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.ITSAConsolidatedTaxCalculation":{"type":"object","properties":{"metadata":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.ITSARetrieveTaxCalculationMetadataResponse"},"inputs":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.ITSATaxCalculationInputs"},"calculation":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.ITSATaxCalculationCalculations"},"messages":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.ITSATaxCalculationMessages"},"links":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Link"}}}},"KashFlow.Accounting.Model.ITSA.ITSARetrieveTaxCalculationMetadataResponse":{"type":"object","properties":{"calculationId":{"type":"string"},"taxYear":{"type":"string"},"requestedBy":{"type":"string"},"requestedTimestamp":{"format":"date-time","type":"string"},"calculationReason":{"type":"string"},"calculationTimestamp":{"format":"date-time","type":"string"},"calculationType":{"type":"string"},"intentToSubmitFinalDeclaration":{"type":"boolean"},"finalDeclaration":{"type":"boolean"},"finalDeclarationTimestamp":{"format":"date-time","type":"string"},"periodFrom":{"type":"string"},"periodTo":{"type":"string"},"finalisationTimestamp":{"format":"date-time","type":"string"},"confirmationTimestamp":{"format":"date-time","type":"string"}}},"KashFlow.Accounting.Model.ITSA.Report.ITSATaxCalculationInputs":{"type":"object","properties":{"personalInformation":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.PersonalInformation"},"incomeSources":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.IncomeSources"},"annualAdjustments":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.AnnualAdjustment"}},"lossesBroughtForward":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.LossesBroughtForward"}},"claims":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.Claim"}},"constructionIndustryScheme":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.ConstructionIndustryScheme"}},"allowancesReliefsAndDeductions":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.AllowancesReliefsAndDeduction"}},"pensionContributionAndCharges":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.PensionContributionAndCharge"}},"other":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.Other"}}}},"KashFlow.Accounting.Model.ITSA.Report.ITSATaxCalculationCalculations":{"type":"object","properties":{"allowancesAndDeductions":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.AllowancesAndDeductions"},"reliefs":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.Reliefs"},"taxDeductedAtSource":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.TaxDeductedAtSource"},"giftAid":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.GiftAid"},"royaltyPayments":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.RoyaltyPayments"},"notionalTax":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.NotionalTax"},"marriageAllowanceTransferredIn":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.MarriageAllowanceTransferredIn"},"pensionContributionReliefs":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.PensionContributionReliefs"},"pensionSavingsTaxCharges":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.PensionSavingsTaxCharges"},"studentLoans":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.StudentLoan"}},"codedOutUnderpayments":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.CodedOutUnderpayments"},"foreignPropertyIncome":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.ForeignPropertyIncome"}},"businessProfitAndLoss":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.BusinessProfitAndLoss"}},"employmentAndPensionsIncome":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.EmploymentAndPensionsIncome"},"employmentExpenses":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.EmploymentExpenses"},"seafarersDeductions":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.SeafarersDeductions"},"foreignTaxForFtcrNotClaimed":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.ForeignTaxForFtcrNotClaimed"},"stateBenefitsIncome":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.StateBenefitsIncome"},"shareSchemesIncome":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.ShareSchemesIncome"},"foreignIncome":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.ForeignIncome"},"chargeableEventGainsIncome":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.ChargeableEventGainsIncome"},"savingsAndGainsIncome":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.SavingsAndGainsIncome"},"dividendsIncome":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.DividendsIncome"},"incomeSummaryTotals":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.IncomeSummaryTotals"},"taxCalculation":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.TaxCalculation"},"previousCalculation":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.PreviousCalculation"},"endOfYearEstimate":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.EndOfYearEstimate"},"lossesAndClaims":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.LossesAndClaims"},"otherIncome":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.OtherIncome"},"transitionProfit":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.TransitionProfit"},"highIncomeChildBenefitCharge":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.HighIncomeChildBenefitCharge"}}},"KashFlow.Accounting.Model.ITSA.Report.ITSATaxCalculationMessages":{"type":"object","properties":{"info":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.Info"}},"warnings":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.Warning"}},"errors":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.Error"}}}},"KashFlow.Accounting.Model.ITSA.Report.PersonalInformation":{"type":"object","properties":{"identifier":{"type":"string"},"dateOfBirth":{"type":"string"},"taxRegime":{"type":"string"},"statePensionAgeDate":{"type":"string"},"studentLoanPlan":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.StudentLoanPlan"}},"class2VoluntaryContributions":{"type":"boolean"},"marriageAllowance":{"type":"string"},"uniqueTaxpayerReference":{"type":"string"},"itsaStatus":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.Report.IncomeSources":{"type":"object","properties":{"businessIncomeSources":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.BusinessIncomeSource"}},"nonBusinessIncomeSources":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.NonBusinessIncomeSource"}}}},"KashFlow.Accounting.Model.ITSA.Report.AnnualAdjustment":{"type":"object","properties":{"incomeSourceId":{"type":"string"},"incomeSourceType":{"type":"string"},"bsasId":{"type":"string"},"receivedDateTime":{"format":"date-time","type":"string"},"applied":{"type":"boolean"}}},"KashFlow.Accounting.Model.ITSA.Report.LossesBroughtForward":{"type":"object","properties":{"lossId":{"type":"string"},"incomeSourceId":{"type":"string"},"incomeSourceType":{"type":"string"},"submissionTimestamp":{"format":"date-time","type":"string"},"lossType":{"type":"string"},"taxYearLossIncurred":{"type":"string"},"currentLossValue":{"format":"int32","type":"integer"},"mtdLoss":{"type":"boolean"}}},"KashFlow.Accounting.Model.ITSA.Report.Claim":{"type":"object","properties":{"claimId":{"type":"string"},"originatingClaimId":{"type":"string"},"incomeSourceId":{"type":"string"},"incomeSourceType":{"type":"string"},"submissionTimestamp":{"format":"date-time","type":"string"},"taxYearClaimMade":{"type":"string"},"claimType":{"type":"string"},"sequence":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.ITSA.Report.ConstructionIndustryScheme":{"type":"object","properties":{"employerRef":{"type":"string"},"contractorName":{"type":"string"},"periodData":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.PeriodDatum"}}}},"KashFlow.Accounting.Model.ITSA.Report.AllowancesReliefsAndDeduction":{"type":"object","properties":{"type":{"type":"string"},"submittedTimestamp":{"format":"date-time","type":"string"},"startDate":{"type":"string"},"endDate":{"type":"string"},"source":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.Report.PensionContributionAndCharge":{"type":"object","properties":{"type":{"type":"string"},"submissionTimestamp":{"format":"date-time","type":"string"},"startDate":{"type":"string"},"endDate":{"type":"string"},"source":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.Report.Other":{"type":"object","properties":{"type":{"type":"string"},"submittedOn":{"format":"date-time","type":"string"}}},"KashFlow.Accounting.Model.ITSA.Report.AllowancesAndDeductions":{"type":"object","properties":{"personalAllowance":{"format":"double","type":"number"},"marriageAllowanceTransferOut":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.MarriageAllowanceTransferOut"},"reducedPersonalAllowance":{"format":"double","type":"number"},"giftOfInvestmentsAndPropertyToCharity":{"format":"double","type":"number"},"blindPersonsAllowance":{"format":"double","type":"number"},"lossesAppliedToGeneralIncome":{"format":"double","type":"number"},"cgtLossSetAgainstInYearGeneralIncome":{"format":"double","type":"number"},"qualifyingLoanInterestFromInvestments":{"format":"double","type":"number"},"postCessationTradeReceipts":{"format":"double","type":"number"},"paymentsToTradeUnionsForDeathBenefits":{"format":"double","type":"number"},"grossAnnuityPayments":{"format":"double","type":"number"},"annuityPayments":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.AnnuityPayments"},"pensionContributions":{"format":"double","type":"number"},"pensionContributionsDetail":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.PensionContributionsDetail"}}},"KashFlow.Accounting.Model.ITSA.Report.Reliefs":{"type":"object","properties":{"residentialFinanceCosts":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.ResidentialFinanceCosts"},"reliefsClaimed":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.ReliefsClaimed"}},"foreignTaxCreditRelief":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.ForeignTaxCreditRelief"},"topSlicingRelief":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.TopSlicingRelief"},"giftAidTaxReductionWhereBasicRateDiffers":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.GiftAidTaxReductionWhereBasicRateDiffers"},"basicRateExtension":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.BasicRateExtension"}}},"KashFlow.Accounting.Model.ITSA.Report.TaxDeductedAtSource":{"type":"object","properties":{"bbsi":{"format":"double","type":"number"},"ukLandAndProperty":{"format":"double","type":"number"},"cis":{"format":"double","type":"number"},"securities":{"format":"double","type":"number"},"voidedIsa":{"format":"double","type":"number"},"payeEmployments":{"format":"double","type":"number"},"occupationalPensions":{"format":"double","type":"number"},"stateBenefits":{"format":"double","type":"number"},"specialWithholdingTaxOrUkTaxPaid":{"format":"double","type":"number"},"inYearAdjustmentCodedInLaterTaxYear":{"format":"double","type":"number"},"taxTakenOffTradingIncome":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.GiftAid":{"type":"object","properties":{"grossGiftAidPayments":{"format":"double","type":"number"},"rate":{"format":"double","type":"number"},"giftAidTax":{"format":"double","type":"number"},"giftAidTaxReductions":{"format":"double","type":"number"},"incomeTaxChargedAfterGiftAidTaxReductions":{"format":"double","type":"number"},"giftAidCharge":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.RoyaltyPayments":{"type":"object","properties":{"royaltyPaymentsAmount":{"format":"double","type":"number"},"rate":{"format":"double","type":"number"},"grossRoyaltyPayments":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.NotionalTax":{"type":"object","properties":{"chargeableGains":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.MarriageAllowanceTransferredIn":{"type":"object","properties":{"amount":{"format":"double","type":"number"},"rate":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.PensionContributionReliefs":{"type":"object","properties":{"totalPensionContributionReliefs":{"format":"double","type":"number"},"pensionContributionDetail":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.PensionContributionDetail"}}},"KashFlow.Accounting.Model.ITSA.Report.PensionSavingsTaxCharges":{"type":"object","properties":{"totalPensionCharges":{"format":"double","type":"number"},"totalTaxPaid":{"format":"double","type":"number"},"totalPensionChargesDue":{"format":"double","type":"number"},"pensionSavingsTaxChargesDetail":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.PensionSavingsTaxChargesDetail"}}},"KashFlow.Accounting.Model.ITSA.Report.StudentLoan":{"type":"object","properties":{"planType":{"type":"string"},"studentLoanTotalIncomeAmount":{"format":"double","type":"number"},"studentLoanChargeableIncomeAmount":{"format":"double","type":"number"},"studentLoanRepaymentAmount":{"format":"double","type":"number"},"studentLoanDeductionsFromEmployment":{"format":"double","type":"number"},"studentLoanRepaymentAmountNetOfDeductions":{"format":"double","type":"number"},"studentLoanApportionedIncomeThreshold":{"format":"double","type":"number"},"studentLoanRate":{"format":"double","type":"number"},"payeIncomeForStudentLoan":{"format":"double","type":"number"},"nonPayeIncomeForStudentLoan":{"format":"double","type":"number"},"uglDeductionAmount":{"format":"double","type":"number"},"pglDeductionAmount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.CodedOutUnderpayments":{"type":"object","properties":{"totalPayeUnderpayments":{"format":"double","type":"number"},"payeUnderpaymentsDetail":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.PayeUnderpaymentsDetail"}},"totalSelfAssessmentUnderpayments":{"format":"double","type":"number"},"totalCollectedSelfAssessmentUnderpayments":{"format":"double","type":"number"},"totalUncollectedSelfAssessmentUnderpayments":{"format":"double","type":"number"},"selfAssessmentUnderpaymentsDetail":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.SelfAssessmentUnderpaymentsDetail"}}}},"KashFlow.Accounting.Model.ITSA.Report.ForeignPropertyIncome":{"type":"object","properties":{"incomeSourceId":{"type":"string"},"incomeSourceType":{"type":"string"},"countryCode":{"type":"string"},"totalIncome":{"format":"double","type":"number"},"totalExpenses":{"format":"double","type":"number"},"netProfit":{"format":"double","type":"number"},"netLoss":{"format":"double","type":"number"},"totalAdditions":{"format":"double","type":"number"},"totalDeductions":{"format":"double","type":"number"},"taxableProfit":{"format":"double","type":"number"},"adjustedIncomeTaxLoss":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.BusinessProfitAndLoss":{"type":"object","properties":{"incomeSourceId":{"type":"string"},"incomeSourceType":{"type":"string"},"incomeSourceName":{"type":"string"},"totalIncome":{"format":"double","type":"number"},"totalExpenses":{"format":"double","type":"number"},"netProfit":{"format":"double","type":"number"},"netLoss":{"format":"double","type":"number"},"totalAdditions":{"format":"double","type":"number"},"totalDeductions":{"format":"double","type":"number"},"accountingAdjustments":{"format":"double","type":"number"},"taxableProfit":{"format":"double","type":"number"},"adjustedIncomeTaxLoss":{"format":"double","type":"number"},"totalBroughtForwardIncomeTaxLosses":{"format":"double","type":"number"},"lossForCSFHL":{"format":"double","type":"number"},"broughtForwardIncomeTaxLossesUsed":{"format":"double","type":"number"},"taxableProfitAfterIncomeTaxLossesDeduction":{"format":"double","type":"number"},"carrySidewaysIncomeTaxLossesUsed":{"format":"double","type":"number"},"broughtForwardCarrySidewaysIncomeTaxLossesUsed":{"format":"double","type":"number"},"totalIncomeTaxLossesCarriedForward":{"format":"double","type":"number"},"class4Loss":{"format":"double","type":"number"},"totalBroughtForwardClass4Losses":{"format":"double","type":"number"},"broughtForwardClass4LossesUsed":{"format":"double","type":"number"},"carrySidewaysClass4LossesUsed":{"format":"double","type":"number"},"totalClass4LossesCarriedForward":{"format":"double","type":"number"},"adjustedProfit":{"format":"double","type":"number"},"outstandingBusinessIncome":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.EmploymentAndPensionsIncome":{"type":"object","properties":{"totalPayeEmploymentAndLumpSumIncome":{"format":"double","type":"number"},"totalOccupationalPensionIncome":{"format":"double","type":"number"},"totalBenefitsInKind":{"format":"double","type":"number"},"tipsIncome":{"format":"double","type":"number"},"employmentAndPensionsIncomeDetail":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.EmploymentAndPensionsIncomeDetail"}}}},"KashFlow.Accounting.Model.ITSA.Report.EmploymentExpenses":{"type":"object","properties":{"totalEmploymentExpenses":{"format":"double","type":"number"},"employmentExpensesDetail":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.EmploymentExpensesDetail"}}},"KashFlow.Accounting.Model.ITSA.Report.SeafarersDeductions":{"type":"object","properties":{"totalSeafarersDeduction":{"format":"double","type":"number"},"seafarersDeductionDetail":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.SeafarersDeductionDetail"}}}},"KashFlow.Accounting.Model.ITSA.Report.ForeignTaxForFtcrNotClaimed":{"type":"object","properties":{"foreignTaxOnForeignEmployment":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.StateBenefitsIncome":{"type":"object","properties":{"totalStateBenefitsIncome":{"format":"double","type":"number"},"totalStateBenefitsTaxPaid":{"format":"double","type":"number"},"stateBenefitsDetail":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.StateBenefitsDetail"},"totalStateBenefitsIncomeExcStatePensionLumpSum":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.ShareSchemesIncome":{"type":"object","properties":{"totalIncome":{"format":"double","type":"number"},"shareSchemeDetail":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.ShareSchemeDetail"}}}},"KashFlow.Accounting.Model.ITSA.Report.ForeignIncome":{"type":"object","properties":{"chargeableOverseasPensionsStateBenefitsRoyalties":{"format":"double","type":"number"},"overseasPensionsStateBenefitsRoyaltiesDetail":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.OverseasPensionsStateBenefitsRoyaltiesDetail"}},"chargeableAllOtherIncomeReceivedWhilstAbroad":{"format":"double","type":"number"},"allOtherIncomeReceivedWhilstAbroadDetail":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.AllOtherIncomeReceivedWhilstAbroadDetail"}},"overseasIncomeAndGains":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.OverseasIncomeAndGains"},"totalForeignBenefitsAndGifts":{"format":"double","type":"number"},"chargeableForeignBenefitsAndGiftsDetail":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.ChargeableForeignBenefitsAndGiftsDetail"}}},"KashFlow.Accounting.Model.ITSA.Report.ChargeableEventGainsIncome":{"type":"object","properties":{"totalOfAllGains":{"format":"double","type":"number"},"totalGainsWithTaxPaid":{"format":"double","type":"number"},"gainsWithTaxPaidDetail":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.GainsWithTaxPaidDetail"}},"totalGainsWithNoTaxPaidAndVoidedIsa":{"format":"double","type":"number"},"gainsWithNoTaxPaidAndVoidedIsaDetail":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.GainsWithNoTaxPaidAndVoidedIsaDetail"}},"totalForeignGainsOnLifePoliciesTaxPaid":{"format":"double","type":"number"},"foreignGainsOnLifePoliciesTaxPaidDetail":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.ForeignGainsOnLifePoliciesTaxPaidDetail"}},"totalForeignGainsOnLifePoliciesNoTaxPaid":{"format":"double","type":"number"},"foreignGainsOnLifePoliciesNoTaxPaidDetail":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.ForeignGainsOnLifePoliciesNoTaxPaidDetail"}}}},"KashFlow.Accounting.Model.ITSA.Report.SavingsAndGainsIncome":{"type":"object","properties":{"totalChargeableSavingsAndGains":{"format":"double","type":"number"},"totalUkSavingsAndGains":{"format":"double","type":"number"},"ukSavingsAndGainsIncome":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.UkSavingsAndGainsIncome"}},"chargeableForeignSavingsAndGains":{"format":"double","type":"number"},"foreignSavingsAndGainsIncome":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.ForeignSavingsAndGainsIncome"}}}},"KashFlow.Accounting.Model.ITSA.Report.DividendsIncome":{"type":"object","properties":{"totalChargeableDividends":{"format":"double","type":"number"},"totalUkDividends":{"format":"double","type":"number"},"ukDividends":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.UkDividends"},"otherDividends":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.OtherDividend"}},"chargeableForeignDividends":{"format":"double","type":"number"},"foreignDividends":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.ForeignDividend"}},"dividendIncomeReceivedWhilstAbroad":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.DividendIncomeReceivedWhilstAbroad"}}}},"KashFlow.Accounting.Model.ITSA.Report.IncomeSummaryTotals":{"type":"object","properties":{"totalSelfEmploymentProfit":{"format":"double","type":"number"},"totalPropertyProfit":{"format":"double","type":"number"},"totalFHLPropertyProfit":{"format":"double","type":"number"},"totalUKOtherPropertyProfit":{"format":"double","type":"number"},"totalForeignPropertyProfit":{"format":"double","type":"number"},"totalEeaFhlProfit":{"format":"double","type":"number"},"totalEmploymentIncome":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.TaxCalculation":{"type":"object","properties":{"incomeTax":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.IncomeTax"},"nics":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.Nics"},"totalTaxDeductedBeforeCodingOut":{"format":"double","type":"number"},"saUnderpaymentsCodedOut":{"format":"double","type":"number"},"totalAnnuityPaymentsTaxCharged":{"format":"double","type":"number"},"totalRoyaltyPaymentsTaxCharged":{"format":"double","type":"number"},"totalIncomeTaxNicsCharged":{"format":"double","type":"number"},"totalStudentLoansRepaymentAmount":{"format":"double","type":"number"},"totalTaxDeducted":{"format":"double","type":"number"},"totalIncomeTaxAndNicsDue":{"format":"double","type":"number"},"capitalGainsTax":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.CapitalGainsTax"},"totalIncomeTaxAndNicsAndCgt":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.PreviousCalculation":{"type":"object","properties":{"calculationTimestamp":{"format":"date-time","type":"string"},"calculationId":{"type":"string"},"totalIncomeTaxAndNicsDue":{"format":"double","type":"number"},"cgtTaxDue":{"format":"double","type":"number"},"totalIncomeTaxAndNicsAndCgtDue":{"format":"double","type":"number"},"incomeTaxNicDueThisPeriod":{"format":"double","type":"number"},"cgtDueThisPeriod":{"format":"double","type":"number"},"totalIncomeTaxAndNicsAndCgtDueThisPeriod":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.EndOfYearEstimate":{"type":"object","properties":{"incomeSource":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.IncomeSource"}},"totalEstimatedIncome":{"format":"double","type":"number"},"totalTaxableIncome":{"format":"double","type":"number"},"incomeTaxAmount":{"format":"double","type":"number"},"nic2":{"format":"double","type":"number"},"nic4":{"format":"double","type":"number"},"totalTaxDeductedBeforeCodingOut":{"format":"double","type":"number"},"saUnderpaymentsCodedOut":{"format":"double","type":"number"},"totalNicAmount":{"format":"double","type":"number"},"totalStudentLoansRepaymentAmount":{"format":"double","type":"number"},"totalAnnuityPaymentsTaxCharged":{"format":"double","type":"number"},"totalRoyaltyPaymentsTaxCharged":{"format":"double","type":"number"},"totalTaxDeducted":{"format":"double","type":"number"},"incomeTaxNicAmount":{"format":"double","type":"number"},"cgtAmount":{"format":"double","type":"number"},"incomeTaxNicAndCgtAmount":{"format":"double","type":"number"},"totalAllowancesAndDeductions":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.ITSA.Report.LossesAndClaims":{"type":"object","properties":{"resultOfClaimsApplied":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.ResultOfClaimsApplied"}},"unclaimedLosses":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.UnclaimedLoss"}},"carriedForwardLosses":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.CarriedForwardLoss"}},"defaultCarriedForwardLosses":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.DefaultCarriedForwardLoss"}},"claimsNotApplied":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.ClaimsNotApplied"}}}},"KashFlow.Accounting.Model.ITSA.Report.OtherIncome":{"type":"object","properties":{"totalOtherIncome":{"format":"int32","type":"integer"},"postCessationIncome":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.PostCessationIncome"}}},"KashFlow.Accounting.Model.ITSA.Report.TransitionProfit":{"type":"object","properties":{"totalTaxableTransitionProfit":{"format":"int32","type":"integer"},"transitionProfitDetail":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.TransitionProfitDetail"}}}},"KashFlow.Accounting.Model.ITSA.Report.HighIncomeChildBenefitCharge":{"type":"object","properties":{"adjustedNetIncome":{"format":"double","type":"number"},"amountOfChildBenefitReceived":{"format":"double","type":"number"},"incomeThreshold":{"format":"double","type":"number"},"childBenefitChargeTaper":{"format":"double","type":"number"},"rate":{"format":"double","type":"number"},"highIncomeBenefitCharge":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.Info":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.Report.Warning":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.Report.Error":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.Report.StudentLoanPlan":{"type":"object","properties":{"planType":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.Report.BusinessIncomeSource":{"type":"object","properties":{"incomeSourceId":{"type":"string"},"incomeSourceType":{"type":"string"},"incomeSourceName":{"type":"string"},"accountingPeriodStartDate":{"type":"string"},"accountingPeriodEndDate":{"type":"string"},"source":{"type":"string"},"latestPeriodEndDate":{"type":"string"},"latestReceivedDateTime":{"format":"date-time","type":"string"},"submissionPeriods":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.SubmissionPeriod"}},"submissionPeriod":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.ConsolidatedSubmissionPeriod"},"cessationDate":{"type":"string"},"commencementDate":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.Report.NonBusinessIncomeSource":{"type":"object","properties":{"incomeSourceId":{"type":"string"},"incomeSourceType":{"type":"string"},"incomeSourceName":{"type":"string"},"startDate":{"type":"string"},"endDate":{"type":"string"},"source":{"type":"string"},"periodId":{"type":"string"},"latestReceivedDateTime":{"format":"date-time","type":"string"}}},"KashFlow.Accounting.Model.ITSA.Report.PeriodDatum":{"type":"object","properties":{"deductionFromDate":{"type":"string"},"deductionToDate":{"type":"string"},"submissionTimestamp":{"format":"date-time","type":"string"},"source":{"type":"string"},"deductionAmount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.MarriageAllowanceTransferOut":{"type":"object","properties":{"personalAllowanceBeforeTransferOut":{"format":"double","type":"number"},"transferredOutAmount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.AnnuityPayments":{"type":"object","properties":{"reliefClaimed":{"format":"double","type":"number"},"rate":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.PensionContributionsDetail":{"type":"object","properties":{"retirementAnnuityPayments":{"format":"double","type":"number"},"paymentToEmployersSchemeNoTaxRelief":{"format":"double","type":"number"},"overseasPensionSchemeContributions":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.ResidentialFinanceCosts":{"type":"object","properties":{"adjustedTotalIncome":{"format":"double","type":"number"},"totalAllowableAmount":{"format":"double","type":"number"},"relievableAmount":{"format":"double","type":"number"},"rate":{"format":"double","type":"number"},"totalResidentialFinanceCostsRelief":{"format":"double","type":"number"},"ukProperty":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.UkProperty"},"foreignProperty":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.ForeignProperty"},"allOtherIncomeReceivedWhilstAbroad":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.AllOtherIncomeReceivedWhilstAbroad"}}},"KashFlow.Accounting.Model.ITSA.Report.ReliefsClaimed":{"type":"object","properties":{"type":{"type":"string"},"amountClaimed":{"format":"double","type":"number"},"allowableAmount":{"format":"double","type":"number"},"amountUsed":{"format":"double","type":"number"},"rate":{"format":"double","type":"number"},"reliefsClaimedDetail":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.ReliefsClaimedDetail"}}}},"KashFlow.Accounting.Model.ITSA.Report.ForeignTaxCreditRelief":{"type":"object","properties":{"customerCalculatedRelief":{"type":"boolean"},"totalForeignTaxCreditRelief":{"format":"double","type":"number"},"foreignTaxCreditReliefOnProperty":{"format":"double","type":"number"},"foreignTaxCreditReliefOnDividends":{"format":"double","type":"number"},"foreignTaxCreditReliefOnSavings":{"format":"double","type":"number"},"foreignTaxCreditReliefOnForeignIncome":{"format":"double","type":"number"},"foreignTaxCreditReliefDetail":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.ForeignTaxCreditReliefDetail"}}}},"KashFlow.Accounting.Model.ITSA.Report.TopSlicingRelief":{"type":"object","properties":{"amount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.GiftAidTaxReductionWhereBasicRateDiffers":{"type":"object","properties":{"Amount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.BasicRateExtension":{"type":"object","properties":{"totalBasicRateExtension":{"format":"double","type":"number"},"giftAidRelief":{"format":"int32","type":"integer"},"pensionContributionReliefs":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.PensionContributionDetail":{"type":"object","properties":{"regularPensionContributions":{"format":"double","type":"number"},"oneOffPensionContributionsPaid":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.PensionSavingsTaxChargesDetail":{"type":"object","properties":{"excessOfLifeTimeAllowance":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.ExcessOfLifeTimeAllowance"},"pensionSchemeUnauthorisedPayments":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.PensionSchemeUnauthorisedPayments"},"pensionSchemeOverseasTransfers":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.PensionSchemeOverseasTransfers"},"pensionContributionsInExcessOfTheAnnualAllowance":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.PensionContributionsInExcessOfTheAnnualAllowance"},"overseasPensionContributions":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.OverseasPensionContributions"}}},"KashFlow.Accounting.Model.ITSA.Report.PayeUnderpaymentsDetail":{"type":"object","properties":{"amount":{"format":"double","type":"number"},"relatedTaxYear":{"type":"string"},"source":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.Report.SelfAssessmentUnderpaymentsDetail":{"type":"object","properties":{"amount":{"format":"double","type":"number"},"relatedTaxYear":{"type":"string"},"source":{"type":"string"},"collectedAmount":{"format":"double","type":"number"},"uncollectedAmount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.EmploymentAndPensionsIncomeDetail":{"type":"object","properties":{"incomeSourceId":{"type":"string"},"source":{"type":"string"},"occupationalPension":{"type":"boolean"},"employerRef":{"type":"string"},"employerName":{"type":"string"},"payrollId":{"type":"string"},"startDate":{"type":"string"},"dateEmploymentEnded":{"type":"string"},"taxablePayToDate":{"format":"double","type":"number"},"totalTaxToDate":{"format":"double","type":"number"},"disguisedRemuneration":{"type":"boolean"},"lumpSums":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.LumpSums"},"studentLoans":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.StudentLoan"},"benefitsInKind":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.BenefitsInKind"},"offPayrollWorker":{"type":"boolean"}}},"KashFlow.Accounting.Model.ITSA.Report.EmploymentExpensesDetail":{"type":"object","properties":{"businessTravelCosts":{"format":"double","type":"number"},"jobExpenses":{"format":"double","type":"number"},"flatRateJobExpenses":{"format":"double","type":"number"},"professionalSubscriptions":{"format":"double","type":"number"},"hotelAndMealExpenses":{"format":"double","type":"number"},"otherAndCapitalAllowances":{"format":"double","type":"number"},"vehicleExpenses":{"format":"double","type":"number"},"mileageAllowanceRelief":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.SeafarersDeductionDetail":{"type":"object","properties":{"nameOfShip":{"type":"string"},"amountDeducted":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.StateBenefitsDetail":{"type":"object","properties":{"incapacityBenefit":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.IncapacityBenefit"}},"statePension":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.StatePension"}},"statePensionLumpSum":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.StatePensionLumpSum"}},"employmentSupportAllowance":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.EmploymentSupportAllowance"}},"jobSeekersAllowance":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.JobSeekersAllowance"}},"bereavementAllowance":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.BereavementAllowance"}},"otherStateBenefits":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.OtherStateBenefit"}}}},"KashFlow.Accounting.Model.ITSA.Report.ShareSchemeDetail":{"type":"object","properties":{"type":{"type":"string"},"employerName":{"type":"string"},"employerRef":{"type":"string"},"taxableAmount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.OverseasPensionsStateBenefitsRoyaltiesDetail":{"type":"object","properties":{"countryCode":{"type":"string"},"grossIncome":{"format":"double","type":"number"},"netIncome":{"format":"double","type":"number"},"taxDeducted":{"format":"double","type":"number"},"foreignTaxCreditRelief":{"type":"boolean"}}},"KashFlow.Accounting.Model.ITSA.Report.AllOtherIncomeReceivedWhilstAbroadDetail":{"type":"object","properties":{"countryCode":{"type":"string"},"grossIncome":{"format":"double","type":"number"},"netIncome":{"format":"double","type":"number"},"taxDeducted":{"format":"double","type":"number"},"foreignTaxCreditRelief":{"type":"boolean"}}},"KashFlow.Accounting.Model.ITSA.Report.OverseasIncomeAndGains":{"type":"object","properties":{"gainAmount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.ChargeableForeignBenefitsAndGiftsDetail":{"type":"object","properties":{"transactionBenefit":{"format":"double","type":"number"},"protectedForeignIncomeSourceBenefit":{"format":"double","type":"number"},"protectedForeignIncomeOnwardGift":{"format":"double","type":"number"},"benefitReceivedAsASettler":{"format":"double","type":"number"},"onwardGiftReceivedAsASettler":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.GainsWithTaxPaidDetail":{"type":"object","properties":{"type":{"type":"string"},"customerReference":{"type":"string"},"gainAmount":{"format":"double","type":"number"},"yearsHeld":{"format":"double","type":"number"},"yearsHeldSinceLastGain":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.GainsWithNoTaxPaidAndVoidedIsaDetail":{"type":"object","properties":{"type":{"type":"string"},"customerReference":{"type":"string"},"gainAmount":{"format":"double","type":"number"},"yearsHeld":{"format":"double","type":"number"},"yearsHeldSinceLastGain":{"format":"double","type":"number"},"voidedIsaTaxPaid":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.ForeignGainsOnLifePoliciesTaxPaidDetail":{"type":"object","properties":{"customerReference":{"type":"string"},"gainAmount":{"format":"double","type":"number"},"taxPaidAmount":{"format":"double","type":"number"},"yearsHeld":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.ForeignGainsOnLifePoliciesNoTaxPaidDetail":{"type":"object","properties":{"customerReference":{"type":"string"},"gainAmount":{"format":"double","type":"number"},"yearsHeld":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.UkSavingsAndGainsIncome":{"type":"object","properties":{"incomeSourceId":{"type":"string"},"incomeSourceType":{"type":"string"},"incomeSourceName":{"type":"string"},"grossIncome":{"format":"double","type":"number"},"netIncome":{"format":"double","type":"number"},"taxDeducted":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.ForeignSavingsAndGainsIncome":{"type":"object","properties":{"incomeSourceType":{"type":"string"},"countryCode":{"type":"string"},"grossIncome":{"format":"double","type":"number"},"netIncome":{"format":"double","type":"number"},"taxDeducted":{"format":"double","type":"number"},"foreignTaxCreditRelief":{"type":"boolean"}}},"KashFlow.Accounting.Model.ITSA.Report.UkDividends":{"type":"object","properties":{"incomeSourceId":{"type":"string"},"incomeSourceType":{"type":"string"},"dividends":{"format":"double","type":"number"},"otherUkDividends":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.OtherDividend":{"type":"object","properties":{"typeOfDividend":{"type":"string"},"customerReference":{"type":"string"},"grossAmount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.ForeignDividend":{"type":"object","properties":{"incomeSourceType":{"type":"string"},"countryCode":{"type":"string"},"grossIncome":{"format":"double","type":"number"},"netIncome":{"format":"double","type":"number"},"taxDeducted":{"format":"double","type":"number"},"foreignTaxCreditRelief":{"type":"boolean"}}},"KashFlow.Accounting.Model.ITSA.Report.DividendIncomeReceivedWhilstAbroad":{"type":"object","properties":{"incomeSourceType":{"type":"string"},"countryCode":{"type":"string"},"grossIncome":{"format":"double","type":"number"},"netIncome":{"format":"double","type":"number"},"taxDeducted":{"format":"double","type":"number"},"foreignTaxCreditRelief":{"type":"boolean"}}},"KashFlow.Accounting.Model.ITSA.IncomeTax":{"type":"object","properties":{"totalIncomeReceivedFromAllSources":{"format":"int32","type":"integer"},"totalAllowancesAndDeductions":{"format":"int32","type":"integer"},"totalTaxableIncome":{"format":"int32","type":"integer"},"payPensionsProfit":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.PayPensionsProfit"},"savingsAndGains":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.SavingsAndGains"},"dividends":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Dividends"},"lumpSums":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.LumpSums"},"gainsOnLifePolicies":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.GainsOnLifePolicies"},"incomeTaxCharged":{"format":"double","type":"number"},"totalReliefs":{"format":"double","type":"number"},"incomeTaxDueAfterReliefs":{"format":"double","type":"number"},"totalNotionalTax":{"format":"double","type":"number"},"marriageAllowanceRelief":{"format":"double","type":"number"},"incomeTaxDueAfterTaxReductions":{"format":"double","type":"number"},"incomeTaxDueAfterGiftAid":{"format":"double","type":"number"},"totalPensionSavingsTaxCharges":{"format":"double","type":"number"},"statePensionLumpSumCharges":{"format":"double","type":"number"},"payeUnderpaymentsCodedOut":{"format":"double","type":"number"},"totalIncomeTaxDue":{"format":"double","type":"number"},"giftAidTaxChargeWhereBasicRateDiffers":{"format":"double","type":"number"},"highIncomeBenefitCharge":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.Nics":{"type":"object","properties":{"class2Nics":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.Class2Nics"},"class4Nics":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.Class4Nics"},"nic2NetOfDeductions":{"format":"double","type":"number"},"nic4NetOfDeductions":{"format":"double","type":"number"},"totalNic":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.CapitalGainsTax":{"type":"object","properties":{"totalCapitalGainsIncome":{"format":"double","type":"number"},"annualExemptionAmount":{"format":"double","type":"number"},"totalTaxableGains":{"format":"double","type":"number"},"businessAssetsDisposalsAndInvestorsRel":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.BusinessAssetsDisposalsAndInvestorsRel"},"residentialPropertyAndCarrieddecimalerest":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.ResidentialPropertyAndCarrieddecimalerest"},"otherGains":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.OtherGains"},"capitalGainsTaxAmount":{"format":"double","type":"number"},"adjustments":{"format":"double","type":"number"},"adjustedCapitalGainsTax":{"format":"double","type":"number"},"foreignTaxCreditRelief":{"format":"double","type":"number"},"capitalGainsTaxAfterFTCR":{"format":"double","type":"number"},"taxOnGainsAlreadyPaid":{"format":"double","type":"number"},"capitalGainsTaxDue":{"format":"double","type":"number"},"capitalGainsOverpaid":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.IncomeSource":{"type":"object","properties":{"incomeSourceId":{"type":"string"},"incomeSourceType":{"type":"string"},"incomeSourceName":{"type":"string"},"taxableIncome":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.ResultOfClaimsApplied":{"type":"object","properties":{"claimId":{"type":"string"},"originatingClaimId":{"type":"string"},"incomeSourceId":{"type":"string"},"incomeSourceType":{"type":"string"},"taxYearClaimMade":{"type":"string"},"claimType":{"type":"string"},"mtdLoss":{"type":"boolean"},"taxYearLossIncurred":{"type":"string"},"lossAmountUsed":{"format":"double","type":"number"},"remainingLossValue":{"format":"double","type":"number"},"lossType":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.Report.UnclaimedLoss":{"type":"object","properties":{"incomeSourceId":{"type":"string"},"incomeSourceType":{"type":"string"},"taxYearLossIncurred":{"type":"string"},"currentLossValue":{"format":"double","type":"number"},"lossType":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.Report.CarriedForwardLoss":{"type":"object","properties":{"claimId":{"type":"string"},"originatingClaimId":{"type":"string"},"incomeSourceId":{"type":"string"},"incomeSourceType":{"type":"string"},"claimType":{"type":"string"},"taxYearClaimMade":{"type":"string"},"taxYearLossIncurred":{"type":"string"},"currentLossValue":{"format":"double","type":"number"},"lossType":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.Report.DefaultCarriedForwardLoss":{"type":"object","properties":{"incomeSourceId":{"type":"string"},"incomeSourceType":{"type":"string"},"taxYearLossIncurred":{"type":"string"},"currentLossValue":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.ClaimsNotApplied":{"type":"object","properties":{"claimId":{"type":"string"},"incomeSourceId":{"type":"string"},"incomeSourceType":{"type":"string"},"taxYearClaimMade":{"type":"string"},"claimType":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.Report.PostCessationIncome":{"type":"object","properties":{"totalPostCessationReceipts":{"format":"double","type":"number"},"postCessationReceipts":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.PostCessationReceipt"}}}},"KashFlow.Accounting.Model.ITSA.Report.TransitionProfitDetail":{"type":"object","properties":{"incomeSourceId":{"type":"string"},"incomeSourceName":{"type":"string"},"transitionProfitAmount":{"format":"double","type":"number"},"transitionProfitAccelerationAmount":{"format":"double","type":"number"},"totalTransitionProfit":{"format":"int32","type":"integer"},"remainingBroughtForwardIncomeTaxLosses":{"format":"int32","type":"integer"},"broughtForwardIncomeTaxLossesUsed":{"format":"int32","type":"integer"},"transitionProfitsAfterIncomeTaxLossDeductions":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.ITSA.Report.SubmissionPeriod":{"type":"object","properties":{"periodId":{"type":"string"},"startDate":{"type":"string"},"endDate":{"type":"string"},"receivedDateTime":{"format":"date-time","type":"string"}}},"KashFlow.Accounting.Model.ITSA.Report.ConsolidatedSubmissionPeriod":{"type":"object","properties":{"submissionId":{"type":"string"},"startDate":{"type":"string"},"endDate":{"type":"string"},"receivedDateTime":{"format":"date-time","type":"string"}}},"KashFlow.Accounting.Model.ITSA.Report.UkProperty":{"type":"object","properties":{"amountClaimed":{"format":"double","type":"number"},"allowableAmount":{"format":"double","type":"number"},"carryForwardAmount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.ForeignProperty":{"type":"object","properties":{"totalForeignPropertyAllowableAmount":{"format":"double","type":"number"},"foreignPropertyRfcDetail":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.ForeignPropertyRfcDetail"}}}},"KashFlow.Accounting.Model.ITSA.Report.AllOtherIncomeReceivedWhilstAbroad":{"type":"object","properties":{"totalOtherIncomeAllowableAmount":{"format":"double","type":"number"},"otherIncomeRfcDetail":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.OtherIncomeRfcDetail"}}}},"KashFlow.Accounting.Model.ITSA.Report.ReliefsClaimedDetail":{"type":"object","properties":{"amountClaimed":{"format":"double","type":"number"},"uniqueInvestmentRef":{"type":"string"},"name":{"type":"string"},"socialEnterpriseName":{"type":"string"},"companyName":{"type":"string"},"deficiencyReliefType":{"type":"string"},"customerReference":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.Report.ForeignTaxCreditReliefDetail":{"type":"object","properties":{"incomeSourceType":{"type":"string"},"incomeSourceId":{"type":"string"},"countryCode":{"type":"string"},"foreignIncome":{"format":"double","type":"number"},"foreignTax":{"format":"double","type":"number"},"dtaRate":{"format":"double","type":"number"},"dtaAmount":{"format":"double","type":"number"},"ukLiabilityOnIncome":{"format":"double","type":"number"},"foreignTaxCredit":{"format":"double","type":"number"},"employmentLumpSum":{"type":"boolean"}}},"KashFlow.Accounting.Model.ITSA.Report.ExcessOfLifeTimeAllowance":{"type":"object","properties":{"totalChargeableAmount":{"format":"double","type":"number"},"totalTaxPaid":{"format":"double","type":"number"},"lumpSumBenefitTakenInExcessOfLifetimeAllowance":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.LumpSumBenefitTakenInExcessOfLifetimeAllowance"},"benefitInExcessOfLifetimeAllowance":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.BenefitInExcessOfLifetimeAllowance"}}},"KashFlow.Accounting.Model.ITSA.Report.PensionSchemeUnauthorisedPayments":{"type":"object","properties":{"totalChargeableAmount":{"format":"double","type":"number"},"totalTaxPaid":{"format":"double","type":"number"},"pensionSchemeUnauthorisedPaymentsSurcharge":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.PensionSchemeUnauthorisedPaymentsSurcharge"},"pensionSchemeUnauthorisedPaymentsNonSurcharge":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.PensionSchemeUnauthorisedPaymentsNonSurcharge"}}},"KashFlow.Accounting.Model.ITSA.Report.PensionSchemeOverseasTransfers":{"type":"object","properties":{"transferCharge":{"format":"double","type":"number"},"transferChargeTaxPaid":{"format":"double","type":"number"},"rate":{"format":"double","type":"number"},"chargeableAmount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.PensionContributionsInExcessOfTheAnnualAllowance":{"type":"object","properties":{"totalContributions":{"format":"double","type":"number"},"totalPensionCharge":{"format":"double","type":"number"},"annualAllowanceTaxPaid":{"format":"double","type":"number"},"totalPensionChargeDue":{"format":"double","type":"number"},"pensionBands":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.PensionBand"}}}},"KashFlow.Accounting.Model.ITSA.Report.OverseasPensionContributions":{"type":"object","properties":{"totalShortServiceRefund":{"format":"double","type":"number"},"totalShortServiceRefundCharge":{"format":"double","type":"number"},"shortServiceRefundTaxPaid":{"format":"double","type":"number"},"totalShortServiceRefundChargeDue":{"format":"double","type":"number"},"shortServiceRefundBands":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.ShortServiceRefundBand"}}}},"KashFlow.Accounting.Model.ITSA.Report.LumpSums":{"type":"object","properties":{"totalLumpSum":{"format":"double","type":"number"},"totalTaxPaid":{"format":"double","type":"number"},"lumpSumsDetail":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.LumpSumsDetail"},"incomeReceived":{"format":"double","type":"number"},"allowancesAllocated":{"format":"double","type":"number"},"taxableIncome":{"format":"double","type":"number"},"incomeTaxAmount":{"format":"double","type":"number"},"taxBands":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.TaxBand"}}}},"KashFlow.Accounting.Model.ITSA.Report.BenefitsInKind":{"type":"object","properties":{"totalBenefitsInKindReceived":{"format":"double","type":"number"},"benefitsInKindDetail":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.BenefitsInKindDetail"}}},"KashFlow.Accounting.Model.ITSA.Report.IncapacityBenefit":{"type":"object","properties":{"incomeSourceId":{"type":"string"},"amount":{"format":"double","type":"number"},"taxPaid":{"format":"double","type":"number"},"source":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.Report.StatePension":{"type":"object","properties":{"incomeSourceId":{"type":"string"},"amount":{"format":"double","type":"number"},"source":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.Report.StatePensionLumpSum":{"type":"object","properties":{"incomeSourceId":{"type":"string"},"amount":{"format":"double","type":"number"},"taxPaid":{"format":"double","type":"number"},"rate":{"format":"double","type":"number"},"source":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.Report.EmploymentSupportAllowance":{"type":"object","properties":{"incomeSourceId":{"type":"string"},"amount":{"format":"double","type":"number"},"taxPaid":{"format":"double","type":"number"},"source":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.Report.JobSeekersAllowance":{"type":"object","properties":{"incomeSourceId":{"type":"string"},"amount":{"format":"double","type":"number"},"taxPaid":{"format":"double","type":"number"},"source":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.Report.BereavementAllowance":{"type":"object","properties":{"incomeSourceId":{"type":"string"},"amount":{"format":"double","type":"number"},"source":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.Report.OtherStateBenefit":{"type":"object","properties":{"incomeSourceId":{"type":"string"},"amount":{"format":"double","type":"number"},"source":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.PayPensionsProfit":{"type":"object","properties":{"incomeReceived":{"format":"int32","type":"integer"},"allowancesAllocated":{"format":"int32","type":"integer"},"taxableIncome":{"format":"int32","type":"integer"},"incomeTaxAmount":{"format":"double","type":"number"},"taxBands":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.TaxBand"}}}},"KashFlow.Accounting.Model.ITSA.SavingsAndGains":{"type":"object","properties":{"incomeReceived":{"format":"int32","type":"integer"},"allowancesAllocated":{"format":"int32","type":"integer"},"taxableIncome":{"format":"int32","type":"integer"},"incomeTaxAmount":{"format":"double","type":"number"},"taxBands":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.TaxBand"}}}},"KashFlow.Accounting.Model.ITSA.Dividends":{"type":"object","properties":{"incomeReceived":{"format":"int32","type":"integer"},"allowancesAllocated":{"format":"int32","type":"integer"},"taxableIncome":{"format":"int32","type":"integer"},"incomeTaxAmount":{"format":"double","type":"number"},"taxBands":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.TaxBand"}}}},"KashFlow.Accounting.Model.ITSA.GainsOnLifePolicies":{"type":"object","properties":{"incomeReceived":{"format":"int32","type":"integer"},"allowancesAllocated":{"format":"int32","type":"integer"},"taxableIncome":{"format":"int32","type":"integer"},"incomeTaxAmount":{"format":"double","type":"number"},"taxBands":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.TaxBand"}}}},"KashFlow.Accounting.Model.ITSA.Report.Class2Nics":{"type":"object","properties":{"amount":{"format":"double","type":"number"},"weeklyRate":{"format":"double","type":"number"},"weeks":{"format":"double","type":"number"},"limit":{"format":"double","type":"number"},"apportionedLimit":{"format":"double","type":"number"},"underSmallProfitThreshold":{"type":"boolean"},"actualClass2Nic":{"type":"boolean"},"underLowerProfitThreshold":{"type":"boolean"}}},"KashFlow.Accounting.Model.ITSA.Report.Class4Nics":{"type":"object","properties":{"totalIncomeLiableToClass4Charge":{"format":"double","type":"number"},"totalClass4LossesAvailable":{"format":"double","type":"number"},"totalClass4LossesUsed":{"format":"double","type":"number"},"totalClass4LossesCarriedForward":{"format":"double","type":"number"},"totalIncomeChargeableToClass4":{"format":"double","type":"number"},"totalAmount":{"format":"double","type":"number"},"nic4Bands":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.Nic4Band"}}}},"KashFlow.Accounting.Model.ITSA.Report.BusinessAssetsDisposalsAndInvestorsRel":{"type":"object","properties":{"gainsIncome":{"format":"double","type":"number"},"lossesBroughtForward":{"format":"double","type":"number"},"lossesArisingThisYear":{"format":"double","type":"number"},"gainsAfterLosses":{"format":"double","type":"number"},"annualExemptionAmount":{"format":"double","type":"number"},"taxableGains":{"format":"double","type":"number"},"rate":{"format":"double","type":"number"},"taxAmount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.ResidentialPropertyAndCarrieddecimalerest":{"type":"object","properties":{"gainsIncome":{"format":"double","type":"number"},"lossesBroughtForward":{"format":"double","type":"number"},"lossesArisingThisYear":{"format":"double","type":"number"},"gainsAfterLosses":{"format":"double","type":"number"},"annualExemptionAmount":{"format":"double","type":"number"},"taxableGains":{"format":"double","type":"number"},"cgtTaxBands":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.CgtTaxBand"}},"totalTaxAmount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.OtherGains":{"type":"object","properties":{"gainsIncome":{"format":"double","type":"number"},"lossesBroughtForward":{"format":"double","type":"number"},"lossesArisingThisYear":{"format":"double","type":"number"},"gainsAfterLosses":{"format":"double","type":"number"},"attributedGains":{"format":"double","type":"number"},"netGains":{"format":"double","type":"number"},"annualExemptionAmount":{"format":"double","type":"number"},"taxableGains":{"format":"double","type":"number"},"cgtTaxBands":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.CgtTaxBand"}},"totalTaxAmount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.PostCessationReceipt":{"type":"object","properties":{"amount":{"format":"double","type":"number"},"taxYearIncomeToBeTaxed":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.Report.ForeignPropertyRfcDetail":{"type":"object","properties":{"countryCode":{"type":"string"},"amountClaimed":{"format":"double","type":"number"},"allowableAmount":{"format":"double","type":"number"},"carryForwardAmount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.OtherIncomeRfcDetail":{"type":"object","properties":{"countryCode":{"type":"string"},"residentialFinancialCostAmount":{"format":"double","type":"number"},"broughtFwdResidentialFinancialCostAmount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.LumpSumBenefitTakenInExcessOfLifetimeAllowance":{"type":"object","properties":{"amount":{"format":"double","type":"number"},"taxPaid":{"format":"double","type":"number"},"rate":{"format":"double","type":"number"},"chargeableAmount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.BenefitInExcessOfLifetimeAllowance":{"type":"object","properties":{"amount":{"format":"double","type":"number"},"taxPaid":{"format":"double","type":"number"},"rate":{"format":"double","type":"number"},"chargeableAmount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.PensionSchemeUnauthorisedPaymentsSurcharge":{"type":"object","properties":{"amount":{"format":"double","type":"number"},"taxPaid":{"format":"double","type":"number"},"rate":{"format":"double","type":"number"},"chargeableAmount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.PensionSchemeUnauthorisedPaymentsNonSurcharge":{"type":"object","properties":{"amount":{"format":"double","type":"number"},"taxPaid":{"format":"double","type":"number"},"rate":{"format":"double","type":"number"},"chargeableAmount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.PensionBand":{"type":"object","properties":{"name":{"type":"string"},"rate":{"format":"double","type":"number"},"bandLimit":{"format":"double","type":"number"},"apportionedBandLimit":{"format":"double","type":"number"},"contributionAmount":{"format":"double","type":"number"},"pensionCharge":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.ShortServiceRefundBand":{"type":"object","properties":{"name":{"type":"string"},"rate":{"format":"double","type":"number"},"bandLimit":{"format":"double","type":"number"},"apportionedBandLimit":{"format":"double","type":"number"},"shortServiceRefundAmount":{"format":"double","type":"number"},"shortServiceRefundCharge":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.LumpSumsDetail":{"type":"object","properties":{"taxableLumpSumsAndCertainIncome":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.TaxableLumpSumsAndCertainIncome"},"benefitFromEmployerFinancedRetirementScheme":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.BenefitFromEmployerFinancedRetirementScheme"},"redundancyCompensationPaymentsOverExemption":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.RedundancyCompensationPaymentsOverExemption"},"redundancyCompensationPaymentsUnderExemption":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Report.RedundancyCompensationPaymentsUnderExemption"}}},"KashFlow.Accounting.Model.ITSA.Report.TaxBand":{"type":"object","properties":{"name":{"type":"string"},"rate":{"format":"double","type":"number"},"bandLimit":{"format":"double","type":"number"},"apportionedBandLimit":{"format":"double","type":"number"},"income":{"format":"double","type":"number"},"taxAmount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.BenefitsInKindDetail":{"type":"object","properties":{"apportionedAccommodation":{"format":"double","type":"number"},"apportionedAssets":{"format":"double","type":"number"},"apportionedAssetTransfer":{"format":"double","type":"number"},"apportionedBeneficialLoan":{"format":"double","type":"number"},"apportionedCar":{"format":"double","type":"number"},"apportionedCarFuel":{"format":"double","type":"number"},"apportionedEducationalServices":{"format":"double","type":"number"},"apportionedEntertaining":{"format":"double","type":"number"},"apportionedExpenses":{"format":"double","type":"number"},"apportionedMedicalInsurance":{"format":"double","type":"number"},"apportionedTelephone":{"format":"double","type":"number"},"apportionedService":{"format":"double","type":"number"},"apportionedTaxableExpenses":{"format":"double","type":"number"},"apportionedVan":{"format":"double","type":"number"},"apportionedVanFuel":{"format":"double","type":"number"},"apportionedMileage":{"format":"double","type":"number"},"apportionedNonQualifyingRelocationExpenses":{"format":"double","type":"number"},"apportionedNurseryPlaces":{"format":"double","type":"number"},"apportionedOtherItems":{"format":"double","type":"number"},"apportionedPaymentsOnEmployeesBehalf":{"format":"double","type":"number"},"apportionedPersonalIncidentalExpenses":{"format":"double","type":"number"},"apportionedQualifyingRelocationExpenses":{"format":"double","type":"number"},"apportionedEmployerProvidedProfessionalSubscriptions":{"format":"double","type":"number"},"apportionedEmployerProvidedServices":{"format":"double","type":"number"},"apportionedIncomeTaxPaidByDirector":{"format":"double","type":"number"},"apportionedTravelAndSubsistence":{"format":"double","type":"number"},"apportionedVouchersAndCreditCards":{"format":"double","type":"number"},"apportionedNonCash":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.Nic4Band":{"type":"object","properties":{"name":{"type":"string"},"rate":{"format":"double","type":"number"},"threshold":{"format":"double","type":"number"},"apportionedThreshold":{"format":"double","type":"number"},"income":{"format":"double","type":"number"},"amount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.CgtTaxBand":{"type":"object","properties":{"name":{"type":"string"},"rate":{"format":"double","type":"number"},"income":{"format":"double","type":"number"},"taxAmount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.Report.TaxableLumpSumsAndCertainIncome":{"type":"object","properties":{"amount":{"format":"double","type":"number"},"taxPaid":{"format":"double","type":"number"},"taxTakenOffInEmployment":{"type":"boolean"}}},"KashFlow.Accounting.Model.ITSA.Report.BenefitFromEmployerFinancedRetirementScheme":{"type":"object","properties":{"amount":{"format":"double","type":"number"},"exemptAmount":{"format":"double","type":"number"},"taxPaid":{"format":"double","type":"number"},"taxTakenOffInEmployment":{"type":"boolean"}}},"KashFlow.Accounting.Model.ITSA.Report.RedundancyCompensationPaymentsOverExemption":{"type":"object","properties":{"amount":{"format":"double","type":"number"},"taxPaid":{"format":"double","type":"number"},"taxTakenOffInEmployment":{"type":"boolean"}}},"KashFlow.Accounting.Model.ITSA.Report.RedundancyCompensationPaymentsUnderExemption":{"type":"object","properties":{"amount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ITSA.CalculationIdResponse":{"type":"object","properties":{"CalculationId":{"type":"string"},"TaxCalculationStatus":{"type":"string"},"TaxCalculationCreatedAt":{"type":"string"},"Type":{"type":"string"},"TaxCalculation":{"type":"string"}}},"KashFlow.Accounting.Model.ITSA.IncomeTaxOrLiablityResponse":{"type":"object","properties":{"TaxCalculation":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.CalculationIdResponse"},"CrystallizationStatus":{"type":"string"},"CrystallizationHMRCStatus":{"type":"string"},"SummaryIncometax":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.IncomeTax"}}},"KashFlow.Accounting.Model.ITSA.ITSARetrieveTaxCalculationResponse":{"type":"object","properties":{"metadata":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.ITSARetrieveTaxCalculationMetadataResponse"},"TaxCalculationJson":{"type":"string"},"correlationId":{"type":"string"},"Status":{"type":"boolean"}}},"KashFlow.Accounting.Model.ITSA.TaxCalculationReportResponse":{"type":"object","properties":{"headers":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Header"}}}},"KashFlow.Accounting.Model.ITSA.Header":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Name":{"type":"string"},"SortOrder":{"format":"int32","type":"integer"},"DoDisplay":{"type":"boolean"},"subHeaders":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.SubHeader"}}}},"KashFlow.Accounting.Model.ITSA.SubHeader":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Name":{"type":"string"},"SortOrder":{"format":"int32","type":"integer"},"DoDisplay":{"type":"boolean"},"properties":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.ITSA.Property"}}}},"KashFlow.Accounting.Model.ITSA.Property":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Name":{"type":"string"},"SortOrder":{"format":"int32","type":"integer"},"Value":{"format":"double","type":"number"},"TotalValue":{"format":"double","type":"number"},"InBracket":{"type":"boolean"},"Description":{"type":"string"}}},"KashFlow.Accounting.DTO.Journal.JournalRequest":{"required":["JournalDate"],"type":"object","properties":{"Category":{"format":"int32","type":"integer"},"JournalDate":{"format":"date-time","type":"string"},"LineItems":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Base.JournalLineItemBase"}},"Comment":{"type":"string"},"ExcludedFromProfitAndLoss":{"type":"boolean"},"IsTemplate":{"type":"boolean"},"TemplateName":{"type":"string"},"VATReturnId":{"format":"int32","type":"integer"},"TradeBorderType":{"type":"string"}}},"KashFlow.Accounting.DTO.Base.JournalLineItemBase":{"required":["Disallowed"],"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"NominalCode":{"format":"int32","type":"integer"},"ProjectNumber":{"format":"int32","type":"integer"},"Comment":{"type":"string"},"Debit":{"format":"double","type":"number"},"Credit":{"format":"double","type":"number"},"Disallowed":{"type":"boolean"}}},"KashFlow.Accounting.DTO.Journal.JournalResponse":{"required":["JournalDate"],"type":"object","properties":{"Number":{"format":"int32","type":"integer"},"JournalName":{"type":"string","readOnly":true},"CategoryDescription":{"type":"string"},"Category":{"format":"int32","type":"integer"},"JournalDate":{"format":"date-time","type":"string"},"LineItems":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Journal.JournalLineItemResponse"}},"TotalAmount":{"format":"double","type":"number"},"LockedBankLines":{"format":"int32","type":"integer"},"Comment":{"type":"string"},"ExcludedFromProfitAndLoss":{"type":"boolean"},"IsTemplate":{"type":"boolean"},"TemplateName":{"type":"string"},"VATReturnId":{"format":"int32","type":"integer"},"TradeBorderType":{"type":"string"}}},"KashFlow.Accounting.DTO.Journal.JournalLineItemResponse":{"required":["DisableDisallowed","Disallowed"],"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"NominalId":{"format":"int32","type":"integer"},"NominalName":{"type":"string"},"NominalCode":{"format":"int32","type":"integer"},"ProjectId":{"format":"int32","type":"integer"},"ProjectName":{"type":"string"},"DisableDisallowed":{"type":"boolean"},"ProjectNumber":{"format":"int32","type":"integer"},"Comment":{"type":"string"},"Debit":{"format":"double","type":"number"},"Credit":{"format":"double","type":"number"},"Disallowed":{"type":"boolean"}}},"KashFlow.Accounting.RestApi.Parameters.JournalFilterParamters":{"type":"object","properties":{"Page":{"format":"int32","description":"The page number to be retrieved. The default value is 1.","type":"integer"},"PerPage":{"format":"int32","description":"The number of records to be returned in a page. The default value is 50. Maximum allowed records per page are 100.","type":"integer"},"Order":{"description":"Whether you want to sort the records in ascending (Asc) or descending (Desc) order. The default sort order is ascending (Asc)","type":"string"},"SortColumn":{"format":"int32","description":"The field using which you would like to sort. Available options are:\r\n            0 = Name\r\n            1 = Date\r\n            2 = Amount\r\n            3 = Category\r\n            default is 0 i.e., name 0 = Name,  1 = Date,  2 = Amount,  3 = Category,  4 = Comment,  5 = TemplateName","enum":[0,1,2,3,4,5],"type":"integer"},"SearchText":{"description":"Provide this when you want to retrieve journals whose name starts with given string.","type":"string"},"JournalEntriesFilter":{"format":"int32","description":"Provide this when you want to retrieve journals having specific type of entries. Available options are:\r\n            0 = All entries\r\n            1 = Unposted entries\r\n            2 = This month entries\r\n            3 = Last month entries\r\n            4 = Templates\r\n            5 = This year entries\r\n            Default is 0 i.e., all entries 0 = AllEntries,  1 = UnpostedEntries,  2 = ThisMonthEntries,  3 = LastMonthEntries,  4 = Templates,  5 = ThisYearEntries","enum":[0,1,2,3,4,5],"type":"integer"},"category":{"format":"int32","description":"Provide this when you want to retrieve journals with specific category. Available options are:\r\n            0 = Standard Journals\r\n            1 = Year End Journals\r\n            2 = Pre Payment and Accruals\r\n            3 = Deprecation\r\n            4 = Wages\r\n            5 = VAT\r\n            6 = VATMoss\r\n            7 = FRS Adjustment Journal\r\n             -1 = All Categories\r\n            Default is 0 i.e., Standard Journals 0 = StandardJournals,  1 = YearEndJournals,  2 = PrePaymentAndAccruals,  3 = Deprecation,  4 = Wages,  5 = VAT,  6 = VATMoss,  7 = FRSAdjustmentJournal,  -1 = AllCategories","enum":[0,1,2,3,4,5,6,7,-1],"type":"integer"},"Project":{"format":"int32","description":"Provide project number if you want to filter journals by specific project","type":"integer"}}},"KashFlow.Accounting.Model.Paging[KashFlow.Accounting.DTO.Journal.JournalListResponse]":{"required":["Data"],"type":"object","properties":{"MetaData":{"$ref":"#/definitions/KashFlow.Accounting.Model.PagingMetadata"},"Data":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Journal.JournalListResponse"}}}},"KashFlow.Accounting.DTO.Journal.JournalListResponse":{"required":["JournalDate"],"type":"object","properties":{"Number":{"format":"int32","type":"integer"},"JournalName":{"type":"string","readOnly":true},"CategoryDescription":{"type":"string"},"Category":{"format":"int32","type":"integer"},"JournalDate":{"format":"date-time","type":"string"},"TotalAmount":{"format":"double","type":"number"},"LockedBankLines":{"format":"int32","type":"integer"},"Comment":{"type":"string"},"ExcludedFromProfitAndLoss":{"type":"boolean"},"IsTemplate":{"type":"boolean"},"TemplateName":{"type":"string"},"VATReturnId":{"format":"int32","type":"integer"},"TradeBorderType":{"type":"string"}}},"KashFlow.Accounting.DTO.JournalTemplate.JournalTemplateResponse":{"type":"object","properties":{"Number":{"format":"int32","type":"integer"},"Name":{"type":"string"},"Note":{"type":"string"},"Category":{"format":"int32","description":" 0 = StandardJournals,  1 = YearEndJournals,  2 = PrePaymentAndAccruals,  3 = Deprecation,  4 = Wages,  5 = VAT,  6 = VATMoss,  7 = FRSAdjustmentJournal,  -1 = AllCategories","enum":[0,1,2,3,4,5,6,7,-1],"type":"integer"},"ExcludedFromProfitAndLoss":{"type":"boolean"},"TradeBorderType":{"type":"string"},"TotalAmount":{"format":"double","type":"number"},"LineItems":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.JournalTemplate.JournalTemplateLineResponse"}}}},"KashFlow.Accounting.DTO.JournalTemplate.JournalTemplateLineResponse":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"NominalCode":{"format":"int32","type":"integer"},"Comment":{"type":"string"},"Debit":{"format":"double","type":"number"},"Credit":{"format":"double","type":"number"},"ProjectNumber":{"format":"int32","type":"integer"},"ProjectName":{"type":"string"},"NominalName":{"type":"string"},"Disallowed":{"type":"boolean"},"DisableDisallowed":{"type":"boolean"}}},"KashFlow.Accounting.DTO.JournalTemplate.JournalTemplateRequest":{"type":"object","properties":{"Name":{"type":"string"},"Note":{"type":"string"},"Category":{"format":"int32","description":" 0 = StandardJournals,  1 = YearEndJournals,  2 = PrePaymentAndAccruals,  3 = Deprecation,  4 = Wages,  5 = VAT,  6 = VATMoss,  7 = FRSAdjustmentJournal,  -1 = AllCategories","enum":[0,1,2,3,4,5,6,7,-1],"type":"integer"},"ExcludedFromProfitAndLoss":{"type":"boolean"},"TradeBorderType":{"type":"string"},"LineItems":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.JournalTemplate.JournalTemplateLineRequest"}}}},"KashFlow.Accounting.DTO.JournalTemplate.JournalTemplateLineRequest":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"NominalCode":{"format":"int32","type":"integer"},"Comment":{"type":"string"},"Debit":{"format":"double","type":"number"},"Credit":{"format":"double","type":"number"},"ProjectNumber":{"format":"int32","type":"integer"},"ProjectName":{"type":"string"},"Disallowed":{"type":"boolean"}}},"KashFlow.Accounting.RestApi.Parameters.JournalTemplateFilterParameters":{"description":"Journal Template Filter Parameter","type":"object","properties":{"Page":{"format":"int32","description":"Page number. (default is 1)","type":"integer"},"PerPage":{"format":"int32","description":"PerPage is number of records per page. (default is 50)","type":"integer"},"Order":{"description":"Sorting order (asc or desc) (default is asc)","type":"string"},"SortColumn":{"format":"int32","description":"The field using which you would like to sort. (default is 0 i.e., Number)\r\n            Available options are: 0 = Number,  1 = Name","enum":[0,1],"type":"integer"},"SearchText":{"description":"Provide this when you want to retrieve journal templates whose name contains with given string.","type":"string"}}},"KashFlow.Accounting.Model.JsError":{"type":"object","properties":{"ErrorObject":{"$ref":"#/definitions/System.Object"},"ErrorString":{"type":"string"}}},"KashFlow.Accounting.Model.Paging[KashFlow.Accounting.Model.Reports.LoginLog.LoginLog]":{"required":["Data"],"type":"object","properties":{"MetaData":{"$ref":"#/definitions/KashFlow.Accounting.Model.PagingMetadata"},"Data":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.LoginLog.LoginLog"}}}},"KashFlow.Accounting.Model.Reports.LoginLog.LoginLog":{"required":["Date","IPAddress","UserName","UserType"],"type":"object","properties":{"Date":{"format":"date-time","type":"string"},"IPAddress":{"type":"string"},"UserName":{"type":"string"},"UserType":{"type":"string"}}},"KashFlow.Core.Model.SendGrid.MailTimeLine":{"type":"object","properties":{"Status":{"type":"string"},"SentDate":{"format":"date-time","type":"string"},"ViewedDate":{"format":"date-time","type":"string"}}},"KashFlow.Accounting.Model.Reports.ManagementReport.CachedReportDetailsWrapper":{"type":"object","properties":{"CachedReportDetails":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.CachedReportDetail"}}}},"KashFlow.Accounting.Model.Reports.CachedReportDetail":{"type":"object","properties":{"Key":{"type":"string"},"State":{"format":"int32","description":" 0 = Created,  1 = Queued,  2 = Cached,  3 = Busted","enum":[0,1,2,3],"type":"integer"},"ReportType":{"format":"int32","description":" 0 = SalesGrowth,  1 = ProfitAndLoss,  2 = IncomeBySource,  3 = AgedCreditors,  4 = AgedDebtors,  5 = BalanceSheet,  6 = TrialBalance,  7 = NominalLedger,  8 = FixedAssetRegister,  -1 = Unknown","enum":[0,1,2,3,4,5,6,7,8,-1],"type":"integer"}}},"KashFlow.Accounting.Model.Reports.ManagementReport.ManagementReportSuite":{"type":"object","properties":{"Created":{"format":"date-time","type":"string"},"Items":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.CachedReportDetail"}}}},"KashFlow.Accounting.DTO.Response.MandateResponse":{"type":"object","properties":{"RequestTime":{"type":"string"},"Status":{"type":"string"},"IsGoCardlessMandateSet":{"type":"boolean"},"CustomerId":{"format":"int32","type":"integer"},"CustomerCode":{"type":"string"},"Amount":{"format":"double","type":"number"},"Description":{"type":"string"},"AmountValidity":{"type":"string"}}},"KashFlow.Accounting.DTO.Request.MandateRequest":{"type":"object","properties":{"Email":{"$ref":"#/definitions/KashFlow.Accounting.DTO.EmailMessage"},"Amount":{"format":"double","type":"number"},"Description":{"type":"string"},"AmountValidity":{"type":"string"}}},"KashFlow.Accounting.DTO.EmailMessage":{"type":"object","properties":{"To":{"type":"string"},"Cc":{"type":"string"},"Bcc":{"type":"string"},"Subject":{"type":"string"},"Body":{"type":"string"},"Attachments":{"$ref":"#/definitions/KashFlow.Accounting.DTO.MailAttachment"},"IsHtml":{"type":"boolean"},"SenderAddress":{"type":"string"},"SenderName":{"type":"string"}}},"KashFlow.Accounting.DTO.MailAttachment":{"type":"object","properties":{"DocumentUrls":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.DocumentUrlAttachment"}},"FileAttachments":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.FileAttachment"}}}},"KashFlow.Accounting.DTO.DocumentUrlAttachment":{"type":"object","properties":{"FileName":{"type":"string"},"Url":{"type":"string"}}},"KashFlow.Accounting.DTO.FileAttachment":{"type":"object","properties":{"Name":{"type":"string"},"AttachmentContent":{"type":"string"}}},"KashFlow.Accounting.Model.ErrorCodes":{"type":"object","properties":{}},"KashFlow.Accounting.Model.Bank.ImportTransactionRequest":{"type":"object","properties":{"EntityType":{"format":"int32","description":" 0 = Invalid,  1 = Invoice,  2 = InvoicePayment,  3 = BatchInvoice,  4 = Purchase,  5 = PurchasePayment,  6 = BatchPurchase,  7 = BankTransaction,  8 = Expense","enum":[0,1,2,3,4,5,6,7,8],"type":"integer"},"EntityRequest":{"$ref":"#/definitions/System.Object"},"Method":{"format":"int32","type":"integer"},"BFSTransactionId":{"format":"int64","type":"integer"},"Description":{"type":"string"},"Amount":{"format":"double","type":"number"},"PaidDate":{"format":"date-time","type":"string"},"EntityReference":{"format":"int32","type":"integer"},"PaidIn":{"format":"double","type":"number"},"PaidOut":{"format":"double","type":"number"},"Iscredit":{"type":"string"}}},"KashFlow.Accounting.Model.MatchingEngine.BankTransactionDraftRequest":{"type":"object","properties":{"BankAccountId":{"format":"int32","type":"integer"},"JsonData":{"type":"string"},"JsonFilter":{"type":"string"}}},"KashFlow.Accounting.Model.Mileage.EngineSize":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Size":{"type":"string"},"EngineTypeId":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.Mileage.EngineType":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Type":{"type":"string"}}},"KashFlow.Accounting.Model.Mileage.Vehicle":{"type":"object","properties":{"Id":{"format":"byte","type":"string"},"Name":{"type":"string"}}},"KashFlow.Accounting.Model.Mileage.MileageEmployee":{"type":"object","properties":{"EmployeeID":{"format":"int32","type":"integer"},"EmployeeName":{"type":"string"}}},"KashFlow.Accounting.Model.Mileage.EmployeeUpdate":{"type":"object","properties":{"Name":{"type":"string"},"UpdatedName":{"type":"string"}}},"KashFlow.Accounting.DTO.Nominal.NominalList":{"required":["Code","Name","Type","NomType"],"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Code":{"format":"int32","type":"integer"},"Name":{"type":"string"},"Type":{"type":"string"},"NomType":{"format":"int32","type":"integer"},"Sa103Code":{"format":"double","type":"number"},"DefaultProduct":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Base.ProductBasicDetails"},"Disallowed":{"type":"boolean"},"ComplianceCode":{"type":"string"},"Archived":{"type":"boolean"},"DigitalService":{"type":"boolean"},"IsProduct":{"format":"int32","type":"integer"},"AutoFillLineItem":{"type":"boolean"},"Price":{"format":"double","type":"number"},"WholeSalePrice":{"format":"double","type":"number"},"VATRate":{"format":"double","type":"number"},"VATExempt":{"type":"boolean"},"Description":{"type":"string"},"Special":{"format":"int32","type":"integer"},"Classification":{"type":"string"},"ControlAccountClassification":{"type":"string"},"AllowDelete":{"type":"boolean"},"PlOption":{"format":"int32","type":"integer"},"BsOption":{"format":"int32","type":"integer"},"IRISCoAName":{"type":"string"},"IsIRISCoA":{"type":"boolean"},"ManageStockLevel":{"type":"boolean"},"QuantityInStock":{"format":"double","type":"number"},"StockWarningQuantity":{"format":"double","type":"number"}}},"KashFlow.Accounting.DTO.Base.ProductBasicDetails":{"type":"object","properties":{"Code":{"type":"string"},"Name":{"type":"string"},"AutoFillLineItem":{"type":"boolean"},"Price":{"format":"double","type":"number"},"WholeSalePrice":{"format":"double","type":"number"},"VATRate":{"format":"double","type":"number"},"VATExempt":{"type":"boolean"},"Description":{"type":"string"},"InUse":{"type":"boolean"}}},"KashFlow.Accounting.DTO.Nominal.NominalRequest":{"required":["Code","Name","Type","NomType"],"type":"object","properties":{"Code":{"format":"int32","type":"integer"},"Name":{"type":"string"},"Type":{"type":"string"},"NomType":{"format":"int32","type":"integer"},"Sa103Code":{"format":"double","type":"number"},"CISRate":{"format":"double","type":"number"},"Disallowed":{"type":"boolean"},"ComplianceCode":{"type":"string"},"Archived":{"type":"boolean"},"DigitalService":{"type":"boolean"},"PrePayments":{"type":"boolean"},"IncludeInECSalesList":{"type":"boolean"},"IsProduct":{"format":"int32","type":"integer"},"AutoFillLineItem":{"type":"boolean"},"Price":{"format":"double","type":"number"},"WholeSalePrice":{"format":"double","type":"number"},"VATRate":{"format":"double","type":"number"},"VATExempt":{"type":"boolean"},"Description":{"type":"string"},"ManageStockLevel":{"type":"boolean"},"QuantityInStock":{"format":"double","type":"number"},"StockWarningQuantity":{"format":"double","type":"number"},"IncrementStockLevelsOnPurchase":{"type":"boolean"},"CreateWhenNotPresent":{"type":"boolean"},"PurchaseNominalCode":{"format":"int32","type":"integer"},"PurchaseSubNominalCode":{"type":"string"}}},"KashFlow.Accounting.DTO.Nominal.NominalResponse":{"required":["Code","Name","Type","NomType"],"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Code":{"format":"int32","type":"integer"},"Name":{"type":"string"},"Type":{"type":"string"},"NomType":{"format":"int32","type":"integer"},"Sa103Code":{"format":"double","type":"number"},"CISRate":{"format":"double","type":"number"},"ComplianceCode":{"type":"string"},"Disallowed":{"type":"boolean"},"Archived":{"type":"boolean"},"DigitalService":{"type":"boolean"},"PrePayments":{"type":"boolean"},"IsProduct":{"format":"int32","type":"integer"},"IncludeInECSalesList":{"type":"boolean"},"AutoFillLineItem":{"type":"boolean"},"Price":{"format":"double","type":"number"},"WholeSalePrice":{"format":"double","type":"number"},"VATRate":{"format":"double","type":"number"},"VATExempt":{"type":"boolean"},"Description":{"type":"string"},"ManageStockLevel":{"type":"boolean"},"QuantityInStock":{"format":"double","type":"number"},"StockWarningQuantity":{"format":"double","type":"number"},"Special":{"format":"int32","type":"integer"},"Classification":{"type":"string"},"ControlAccountClassification":{"type":"string"},"AllowDelete":{"type":"boolean"},"PlOption":{"format":"int32","type":"integer"},"BsOption":{"format":"int32","type":"integer"},"IRISCoAName":{"type":"string"},"IncrementStockLevelsOnPurchase":{"type":"boolean"},"IsIRISCoA":{"type":"boolean"},"PurchaseNominalCode":{"format":"int32","type":"integer"},"PurchaseSubNominalCode":{"type":"string"},"PurchaseNominalId":{"format":"int32","type":"integer"},"PurchaseSubNominalId":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.DTO.Wrapper.NominalWarpper":{"type":"object","properties":{"nomList":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Nominal.NominalSa103Request"}}}},"KashFlow.Accounting.DTO.Nominal.NominalSa103Request":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Sa103Code":{"format":"double","type":"number"},"Disallowed":{"type":"boolean"},"Type":{"type":"string"}}},"System.Tuple[System.Collections.Generic.IList[KashFlow.Accounting.Model.NominalBasic],KashFlow.Accounting.DTO.Nominal.NominalResponse]":{"type":"object","properties":{"m_Item1":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.NominalBasic"}},"m_Item2":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Nominal.NominalResponse"}}},"KashFlow.Accounting.Model.NominalBasic":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Code":{"format":"int32","type":"integer"},"Name":{"type":"string"}}},"KashFlow.Accounting.DTO.Nominal.NominalDiscountRequest":{"type":"object","properties":{"Name":{"type":"string"}}},"KashFlow.Accounting.DTO.Nominal.NominalSpecialRequest":{"type":"object","properties":{"Code":{"format":"int32","type":"integer"},"Name":{"type":"string"},"Type":{"type":"string"},"NomType":{"format":"int32","type":"integer"},"Special":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.Sa103Category":{"type":"object","properties":{"Name":{"type":"string"},"Code":{"format":"double","type":"number"},"ValidNominalType":{"type":"string"}}},"KashFlow.Accounting.Model.Reports.NominalBreakdownReport.NominalBreakdownReportRequest":{"required":["StartDate","EndDate"],"type":"object","properties":{"StartDate":{"type":"string"},"EndDate":{"type":"string"},"Code":{"format":"int32","type":"integer"},"AccountingType":{"format":"int32","description":" 0 = Cash,  1 = Accrual","enum":[0,1],"type":"integer"},"ProjectNumber":{"format":"int32","type":"integer"},"Page":{"format":"int32","type":"integer"},"PerPage":{"format":"int32","type":"integer"},"Order":{"type":"string"},"SortBy":{"format":"int32","description":" 1 = Date,  2 = Reference,  3 = Narrative,  4 = DebitValue,  5 = CreditValue,  6 = ResourceNumber,  7 = EntityType,  8 = ProductCode","enum":[1,2,3,4,5,6,7,8],"type":"integer"}}},"KashFlow.Accounting.Model.Paging[KashFlow.Accounting.Model.Reports.NominalBreakdownReport.NominalBreakdownReportItem,KashFlow.Accounting.Model.Reports.NominalBreakdownReport.NominalBreakdownReportPagingMetadata]":{"required":["Data"],"type":"object","properties":{"MetaData":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.NominalBreakdownReport.NominalBreakdownReportPagingMetadata"},"Data":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.NominalBreakdownReport.NominalBreakdownReportItem"}}}},"KashFlow.Accounting.Model.Reports.NominalBreakdownReport.NominalBreakdownReportPagingMetadata":{"type":"object","properties":{"TotalDebit":{"format":"double","type":"number"},"TotalCredit":{"format":"double","type":"number"},"BalanceCredit":{"format":"double","type":"number"},"BalanceDebit":{"format":"double","type":"number"},"TotalRecords":{"format":"int32","type":"integer"},"FirstPageUrl":{"type":"string"},"LastPageUrl":{"type":"string"},"PreviousPageUrl":{"type":"string"},"NextPageUrl":{"type":"string"},"TotalAmount":{"format":"double","type":"number"},"InvoiceLimitReached":{"type":"boolean"}}},"KashFlow.Accounting.Model.Reports.NominalBreakdownReport.NominalBreakdownReportItem":{"type":"object","properties":{"Id":{"format":"int64","type":"integer"},"LineId":{"format":"int64","type":"integer"},"ProductCode":{"type":"string"},"ProductName":{"type":"string"},"Date":{"type":"string"},"Reference":{"type":"string"},"SecondaryReference":{"type":"string"},"Narrative":{"type":"string"},"DebitValue":{"format":"double","type":"number"},"CreditValue":{"format":"double","type":"number"},"ResourceNumber":{"type":"string"},"EntityType":{"type":"string"},"BankAccountId":{"format":"int32","type":"integer"},"IsLocked":{"type":"boolean"}}},"KashFlow.Accounting.Model.Reports.NominalBreakdownReport.NominalBreakdownReassignRequest":{"required":["SourceNominalCode","NominalCode","Transactions"],"type":"object","properties":{"SourceNominalCode":{"format":"int32","type":"integer"},"NominalCode":{"format":"int32","type":"integer"},"ProductCode":{"type":"string"},"Transactions":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.NominalBreakdownReport.NominalBreakdownReassignTransactionItem"}}}},"KashFlow.Accounting.Model.Reports.NominalBreakdownReport.NominalBreakdownReassignTransactionItem":{"type":"object","properties":{"ResourceNumber":{"format":"int64","type":"integer"},"LineId":{"format":"int64","type":"integer"},"EntityType":{"format":"int32","description":" 1 = Invoice,  2 = Purchase,  3 = Bank,  4 = Journal","enum":[1,2,3,4],"type":"integer"}}},"KashFlow.Accounting.Model.Reports.NominalBreakdownReport.NominalBreakdownReassignResponse":{"type":"object","properties":{"Results":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.NominalBreakdownReport.NominalBreakdownReassignResultItem"}}}},"KashFlow.Accounting.Model.Reports.NominalBreakdownReport.NominalBreakdownReassignResultItem":{"type":"object","properties":{"ResourceNumber":{"format":"int64","type":"integer"},"LineId":{"format":"int64","type":"integer"},"EntityType":{"format":"int32","description":" 1 = Invoice,  2 = Purchase,  3 = Bank,  4 = Journal","enum":[1,2,3,4],"type":"integer"},"IsSuccessful":{"type":"boolean"},"ErrorCode":{"type":"string"},"ErrorMessage":{"type":"string"}}},"KashFlow.Accounting.Data.Reports.NominalLedgerReportRequest":{"type":"object","properties":{"StartDate":{"format":"date-time","type":"string"},"EndDate":{"format":"date-time","type":"string"},"NominalIds":{"type":"array","items":{"format":"int32","type":"integer"}},"FilterByProject":{"type":"boolean"},"ProjectId":{"format":"int32","type":"integer"},"IncludeOpeningBalance":{"type":"boolean"},"ForDisallow":{"type":"boolean"},"AccountingType":{"type":"boolean"}}},"KashFlow.Accounting.Model.Reports.NominalLedgerReport.NominalLedgerReport":{"required":["StartDate","EndDate","NominalIds"],"type":"object","properties":{"StartDate":{"type":"string"},"EndDate":{"type":"string"},"NominalIds":{"type":"array","items":{"format":"int32","type":"integer"}},"ProjectId":{"format":"int32","type":"integer"},"IncludeOpeningBalance":{"type":"boolean"},"Items":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.NominalLedgerReport.NominalLedgerReportItem"}}}},"KashFlow.Accounting.Model.Reports.NominalLedgerReport.NominalLedgerReportItem":{"required":["NominalId","NominalCode","NominalName","Date","Val","Url","Uri","Ref","Ref2","DataType"],"type":"object","properties":{"NominalId":{"format":"int32","type":"integer"},"NominalCode":{"format":"int32","type":"integer"},"NominalName":{"type":"string"},"Date":{"type":"string"},"Val":{"format":"double","type":"number"},"Url":{"type":"string"},"Uri":{"type":"string"},"Ref":{"type":"string"},"Ref2":{"type":"string"},"Narrative":{"type":"string"},"DataType":{"format":"int32","type":"integer"},"OpeningBalance":{"format":"double","type":"number"},"ProjectId":{"format":"int32","type":"integer"},"ProjectNumber":{"format":"int32","type":"integer"},"ProjectRef":{"type":"string"},"Code":{"type":"string"},"Name":{"type":"string"},"Reference":{"type":"string"},"ProjectName":{"type":"string"}}},"KashFlow.Accounting.DTO.Base.NoteResponse":{"required":["Number","Text","Date","LastModifiedBy"],"type":"object","properties":{"Number":{"format":"int32","type":"integer"},"Text":{"type":"string"},"Date":{"type":"string"},"LastModifiedBy":{"type":"string"}}},"KashFlow.Accounting.DTO.Base.NoteBase":{"required":["Text"],"type":"object","properties":{"Text":{"type":"string"}}},"KashFlow.Accounting.DTO.Note.NoteRequest":{"required":["Text"],"type":"object","properties":{"Number":{"format":"int32","type":"integer"},"Text":{"type":"string"}}},"KashFlow.Accounting.Model.OCR.OcrPageUtilizationResponse":{"type":"object","properties":{"ForExpense":{"format":"int32","type":"integer"},"ForInvoice":{"format":"int32","type":"integer"},"ForPurchase":{"format":"int32","type":"integer"},"IsDisabled":{"type":"boolean"},"DisabledOn":{"type":"string"},"TotalExtracted":{"format":"int32","type":"integer"},"AllowedExtraction":{"format":"int32","type":"integer"},"PackageName":{"type":"string"},"ActiveFrom":{"type":"string"},"ActiveTill":{"type":"string"}}},"KashFlow.Accounting.DTO.Response.PartnerResponse":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Name":{"type":"string"},"CompanyName":{"type":"string"},"Email":{"type":"string"},"Address":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Base.AddressBase"},"Telephone":{"type":"string"},"Ref":{"type":"string"},"SubscriptionStart":{"format":"date-time","type":"string"},"SubscriptionEnd":{"format":"date-time","type":"string"},"PromoCode":{"type":"string"},"CreatedBy":{"type":"string"},"PIVACERef":{"type":"string"},"SalesAgentId":{"format":"int32","type":"integer"},"UsingOldModel":{"type":"boolean"},"ManagedBy":{"type":"string"},"KashFlowCustomerId":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.DTO.Base.AddressBase":{"type":"object","properties":{"Line1":{"type":"string"},"Line2":{"type":"string"},"Line3":{"type":"string"},"Line4":{"type":"string"},"PostCode":{"type":"string"}}},"KashFlow.Accounting.Model.UserCredentialResetDetail":{"type":"object","properties":{"UserName":{"type":"string"},"Email":{"type":"string"},"TokenKey":{"type":"string"},"ResetMemorableWord":{"type":"boolean"},"Password":{"type":"string"},"MemorableWord":{"type":"string"},"CaptchaToken":{"type":"string"}}},"KashFlow.Accounting.Model.Credential":{"type":"object","properties":{"Password":{"$ref":"#/definitions/KashFlow.Accounting.Model.CredentialDetail"},"MemorableWord":{"$ref":"#/definitions/KashFlow.Accounting.Model.CredentialDetail"}}},"KashFlow.Accounting.Model.CredentialDetail":{"type":"object","properties":{"Current":{"type":"string"},"New":{"type":"string"},"Confirm":{"type":"string"}}},"KashFlow.Accounting.Model.Security.BreachedPasswordRequest":{"type":"object","properties":{"Password":{"type":"string"}}},"KashFlow.Accounting.Model.PaymentMethod":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Name":{"type":"string"},"IsDefault":{"type":"boolean"}}},"KashFlow.Accounting.Model.PaymentProcessor":{"type":"object","properties":{"Title":{"type":"string"},"Description":{"type":"string"},"Order":{"format":"int32","type":"integer"},"LogoFileName":{"type":"string"},"UrlText":{"type":"string"},"RegLink":{"type":"string"},"Id":{"format":"int32","type":"integer"},"CardPaymentType":{"format":"int32","description":" 0 = NoCardPayments,  1 = SecureHosting,  2 = SagePay,  3 = IridiumCorp,  4 = Worldpay,  5 = ProcessingPoint,  6 = SagePaymentSolutions,  7 = SmartPay,  8 = AuthorizeDotNet,  9 = PayPalPro,  10 = PaymentSense,  11 = CardSave,  12 = CardStream,  14 = BarclayCardEPdq,  15 = GoCardless,  16 = McpePayPoint,  17 = GlobalPayments,  18 = EWayPayment,  19 = Stripe,  20 = BarclayCardEPdqExtraPlus,  21 = Square,  22 = IRISPay","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,14,15,16,17,18,19,20,21,22],"type":"integer"},"IsDefault":{"type":"boolean"},"HasConfig":{"type":"boolean"}}},"KashFlow.Accounting.Model.WorldPayPaymentProcessor":{"type":"object","properties":{"MerchantCode":{"type":"string"},"Password":{"type":"string"},"InstallationId":{"type":"string"},"BankAccountId":{"format":"int32","type":"integer"},"CurrencyCode":{"type":"string"},"PaymentMethod":{"format":"int32","type":"integer"},"TestMode":{"type":"boolean"},"IsDefault":{"type":"boolean"},"ConfigurationStatus":{"type":"string"},"PayOnlineImageColor":{"type":"string"},"PaymentNotification":{"type":"boolean"}}},"KashFlow.Accounting.Model.Payment.CardPaymentConfigurations":{"type":"object","properties":{"PaymentMethodId":{"format":"int64","type":"integer"},"AccountId":{"format":"int32","type":"integer"},"ServiceProvider":{"format":"int32","description":" 0 = NoCardPayments,  1 = SecureHosting,  2 = SagePay,  3 = IridiumCorp,  4 = Worldpay,  5 = ProcessingPoint,  6 = SagePaymentSolutions,  7 = SmartPay,  8 = AuthorizeDotNet,  9 = PayPalPro,  10 = PaymentSense,  11 = CardSave,  12 = CardStream,  14 = BarclayCardEPdq,  15 = GoCardless,  16 = McpePayPoint,  17 = GlobalPayments,  18 = EWayPayment,  19 = Stripe,  20 = BarclayCardEPdqExtraPlus,  21 = Square,  22 = IRISPay","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,14,15,16,17,18,19,20,21,22],"type":"integer"},"ServiceUsername":{"type":"string"},"ServicePassword":{"type":"string"},"ConfigurableVariable1":{"type":"string"},"ConfigurableVariable2":{"type":"string"},"Note":{"type":"string"},"Currency":{"type":"string"},"TestMode":{"type":"boolean"},"StripeToken":{"type":"string"},"StripePublishableKey":{"type":"string"},"IsDefault":{"type":"boolean"},"PayOnlineUsesDefault":{"type":"boolean"},"RefreshToken":{"type":"string"},"PayOnlineButtonInEmail":{"type":"boolean"},"InvoiceEmailReminder":{"type":"boolean"},"EnableWithdrawals":{"type":"boolean"},"WithdrawToAccountId":{"format":"int32","type":"integer"},"WithdrawFeeNominalId":{"format":"int32","type":"integer"},"HideIrisDDWidget":{"type":"boolean"}}},"KashFlow.Accounting.Model.OAuth.OAuthAuthorizationResponse":{"type":"object","properties":{"code":{"type":"string"},"redirect_uri":{"type":"string"},"state":{"type":"string"},"refresh_token":{"type":"string"},"error":{"type":"string"},"error_description":{"type":"string"}}},"KashFlow.Accounting.Business.Payment.Model.TransactionMetadata":{"type":"object","properties":{"TotalPaid":{"format":"double","type":"number"},"TotalRefunded":{"format":"double","type":"number"}}},"KashFlow.Accounting.RestApi.Util.EnumValue":{"type":"object","properties":{"Name":{"type":"string"},"Value":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.DTO.PaymentUnallocation.PaymentUnallocationResponse":{"required":["Id"],"type":"object","properties":{"Id":{"format":"int64","type":"integer"}}},"KashFlow.Accounting.Model.InvoicePayOnline":{"type":"object","properties":{"Status":{"type":"string"},"Uid":{"format":"int32","type":"integer"},"TotalInvoice":{"format":"double","type":"number"},"Amount":{"format":"double","type":"number"},"VatAmount":{"format":"double","type":"number"},"DueDate":{"format":"date-time","type":"string"},"FormattedAmount":{"type":"string"},"CardCurrencyCode":{"type":"string"},"CardCurrencySymbol":{"type":"string"},"InvoiceNumber":{"format":"int32","type":"integer"},"InvoiceName":{"type":"string"},"CustomerName":{"type":"string"},"CustomerEmail":{"type":"string"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"Telephone":{"type":"string"},"CustomerCode":{"type":"string"},"CustomerAddress":{"$ref":"#/definitions/KashFlow.Core.Model.Address"},"CustomerPostCode":{"type":"string"},"CompanyName":{"type":"string"},"TestMode":{"type":"boolean"},"MerchantConfig1":{"type":"string"},"MerchantConfig2":{"type":"string"},"MerchantConfig3":{"type":"string"},"MerchantConfig4":{"type":"string"},"MerchantName":{"type":"string"},"LogoLink":{"type":"string"},"CardProcessorType":{"format":"int32","description":" 0 = NoCardPayments,  1 = SecureHosting,  2 = SagePay,  3 = IridiumCorp,  4 = Worldpay,  5 = ProcessingPoint,  6 = SagePaymentSolutions,  7 = SmartPay,  8 = AuthorizeDotNet,  9 = PayPalPro,  10 = PaymentSense,  11 = CardSave,  12 = CardStream,  14 = BarclayCardEPdq,  15 = GoCardless,  16 = McpePayPoint,  17 = GlobalPayments,  18 = EWayPayment,  19 = Stripe,  20 = BarclayCardEPdqExtraPlus,  21 = Square,  22 = IRISPay","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,14,15,16,17,18,19,20,21,22],"type":"integer"},"CardProcessorName":{"type":"string"},"ApplicationName":{"type":"string"},"Permalink":{"type":"string"},"ShowCardHolderAddress":{"type":"boolean"},"ShowCardDetails":{"type":"boolean"},"ShowEmail":{"type":"boolean"},"UseIframe":{"type":"boolean"},"ISOCountries":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Payment.CardPaymentCountry"}},"CustomerKey":{"type":"string"}}},"KashFlow.Accounting.Model.Payment.CardPaymentCountry":{"type":"object","properties":{"CountryCode":{"type":"string"},"CountryName":{"type":"string"}}},"KashFlow.Accounting.Model.Payment.GlobalPayments.IframeData":{"type":"object","properties":{"CustomerEmail":{"type":"string"},"CustomerPhoneMobile":{"type":"string"},"StreetAddress1":{"type":"string"},"StreetAddress2":{"type":"string"},"StreetAddress3":{"type":"string"},"City":{"type":"string"},"PostalCode":{"type":"string"},"Country":{"type":"string"},"CountryCode":{"type":"string"},"Amount":{"format":"double","type":"number"},"Currency":{"type":"string"},"InvoiceNumber":{"type":"string"}}},"KashFlow.Accounting.Model.Payment.Worldpay.WorldPayRequest":{"type":"object","properties":{"Amount":{"format":"double","type":"number"},"InvoiceNo":{"format":"int32","type":"integer"},"Currency":{"type":"string"},"RecaptchaToken":{"type":"string"}}},"KashFlow.Accounting.Model.PayPal.PayPalSetupBase":{"type":"object","properties":{"ProfileId":{"format":"int32","type":"integer"},"Email":{"type":"string"}}},"KashFlow.Accounting.Model.PayPal.PayPalSetupRequest":{"type":"object","properties":{"Guid":{"type":"string"},"IsActivate":{"type":"boolean"},"ProfileId":{"format":"int32","type":"integer"},"Email":{"type":"string"}}},"KashFlow.Accounting.Model.PayPal.PayPalProfileSettings":{"type":"object","properties":{"CustomerId":{"format":"int32","type":"integer"},"ProductId":{"format":"int32","type":"integer"},"VatRate":{"format":"double","type":"number"},"AccIdPayments":{"format":"int32","type":"integer"},"AccIdCharges":{"format":"int32","type":"integer"},"AccIdTransfers":{"format":"int32","type":"integer"},"AccIdPaymentsMade":{"format":"int32","type":"integer"},"AccIdDebitCards":{"format":"int32","type":"integer"},"AccIdBill":{"format":"int32","type":"integer"},"AccIdOrder":{"format":"int32","type":"integer"},"AccIdAtm":{"format":"int32","type":"integer"},"AccIdServices":{"format":"int32","type":"integer"},"TypeDebit":{"format":"int32","type":"integer"},"TypeBill":{"format":"int32","type":"integer"},"TypeServices":{"format":"int32","type":"integer"},"TypeOrder":{"format":"int32","type":"integer"},"TypeAtm":{"format":"int32","type":"integer"},"PayPalUsername":{"type":"string"},"Disabled":{"type":"boolean"},"LastChecked":{"format":"int64","type":"integer"},"ChargeId":{"format":"int32","type":"integer"},"LastTransDate":{"format":"int64","type":"integer"},"EmailConfirmed":{"type":"boolean"},"VatRatePurchases":{"format":"double","type":"number"},"SupplierId":{"format":"int32","type":"integer"},"OutType":{"format":"int32","type":"integer"},"PayMethod":{"format":"int32","type":"integer"},"IncCountry":{"format":"int32","type":"integer"},"HomeCountry":{"format":"int32","type":"integer"},"CustomerSource":{"format":"int32","type":"integer"},"ConvertCurrency":{"type":"boolean"},"PayPalEmail":{"type":"string"},"IncTxId":{"format":"int32","type":"integer"},"ApplyVatToForeignTxs":{"type":"boolean"},"UsePayPalFiguresForInvoices":{"type":"boolean"},"UsePayPalFiguresForPurchases":{"type":"boolean"},"ApplyVatForEcSales":{"type":"boolean"},"ApplyVatForNonEcSales":{"type":"boolean"},"SetCustomerDefaultForEcOrNonEc":{"type":"boolean"},"LastStatus":{"type":"string"},"LastStatusMessage":{"type":"string"},"TransactionTypeFilters":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.PayPal.PayPalTransactionTypeFilter"}},"PaymentStatusFilters":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.PayPal.PayPalStatusFilter"}},"PurchaseStatusFilters":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.PayPal.PayPalStatusFilter"}},"TransferStatusFilters":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.PayPal.PayPalStatusFilter"}}}},"KashFlow.Accounting.Model.PayPal.PayPalTransactionTypeFilter":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Name":{"type":"string"},"Allow":{"type":"boolean"}}},"KashFlow.Accounting.Model.PayPal.PayPalStatusFilter":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Status":{"type":"string"},"KfEntity":{"format":"int32","type":"integer"},"Allow":{"type":"boolean"}}},"KashFlow.Accounting.Model.PayPal.SetupConfig":{"type":"object","properties":{"ProfileId":{"format":"int32","type":"integer"},"AccountId":{"format":"int32","type":"integer"},"AccountName":{"type":"string"},"NominalId":{"format":"int32","type":"integer"},"SalesNominalId":{"format":"int32","type":"integer"},"PurchasesNominalId":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.RestApi.Parameters.DocumentFilterParameters":{"description":"Document Filter Parameters.","type":"object","properties":{"Token":{"description":"Document Token","type":"string"},"StartDate":{"description":"Start Date","type":"string"},"EndDate":{"description":"End Date","type":"string"},"ExcludePaid":{"format":"int32","description":"Exclude Paid","type":"integer"},"ExcludeCustOB":{"format":"int32","description":"Exclude Opening Balance","type":"integer"},"Media":{"format":"int32","description":"Media 0 = Print,  1 = Email,  2 = ViaPost","enum":[0,1,2],"type":"integer"},"Theme":{"format":"int32","description":"Theme","type":"integer"},"FilterBy":{"description":"FilterBy","type":"string"},"outputType":{"format":"int32","description":"outputType","type":"integer"},"BatchPaymentNumber":{"format":"int32","description":"BatchPaymentNumber","type":"integer"}}},"KashFlow.Accounting.DTO.Product.ProductResponse":{"required":["NominalId","Code","Name","NominalCode"],"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"NominalId":{"format":"int64","type":"integer"},"Code":{"type":"string"},"Name":{"type":"string"},"NominalCode":{"format":"int32","type":"integer"},"IsDefault":{"type":"boolean"},"AutoFillLineItem":{"type":"boolean"},"Price":{"format":"double","type":"number"},"WholeSalePrice":{"format":"double","type":"number"},"VATRate":{"format":"double","type":"number"},"VATExempt":{"type":"boolean"},"Description":{"type":"string"},"ManageStockLevel":{"type":"boolean"},"QuantityInStock":{"format":"int32","type":"integer"},"StockWarningQuantity":{"format":"int32","type":"integer"},"InUse":{"type":"boolean"},"PurchaseNominalId":{"format":"int32","type":"integer"},"PurchaseSubNominalId":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.DTO.Product.ProductRequest":{"required":["Code","Name","NominalCode"],"type":"object","properties":{"Code":{"type":"string"},"Name":{"type":"string"},"NominalCode":{"format":"int32","type":"integer"},"IsDefault":{"type":"boolean"},"AutoFillLineItem":{"type":"boolean"},"Price":{"format":"double","type":"number"},"WholeSalePrice":{"format":"double","type":"number"},"VATRate":{"format":"double","type":"number"},"VATExempt":{"type":"boolean"},"Description":{"type":"string"},"ManageStockLevel":{"type":"boolean"},"QuantityInStock":{"format":"int32","type":"integer"},"StockWarningQuantity":{"format":"int32","type":"integer"},"IncrementStockLevelsOnPurchase":{"type":"boolean"},"CreateWhenNotPresent":{"type":"boolean"},"PurchaseNominalCode":{"format":"int32","type":"integer"},"PurchaseSubNominalCode":{"type":"string"}}},"KashFlow.Accounting.DTO.Product.ProductDetailsResponse":{"required":["NominalId","Code","Name","NominalCode"],"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"NominalId":{"format":"int64","type":"integer"},"Code":{"type":"string"},"Name":{"type":"string"},"NominalCode":{"format":"int32","type":"integer"},"IsDefault":{"type":"boolean"},"AutoFillLineItem":{"type":"boolean"},"Price":{"format":"double","type":"number"},"WholeSalePrice":{"format":"double","type":"number"},"VATRate":{"format":"double","type":"number"},"VATExempt":{"type":"boolean"},"Description":{"type":"string"},"ManageStockLevel":{"type":"boolean"},"QuantityInStock":{"format":"int32","type":"integer"},"StockWarningQuantity":{"format":"int32","type":"integer"},"InUse":{"type":"boolean"},"IncrementStockLevelsOnPurchase":{"type":"boolean"},"PurchaseNominalId":{"format":"int32","type":"integer"},"PurchaseSubNominalId":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.RestApi.Parameters.ProductFilterParameters":{"type":"object","properties":{"Page":{"format":"int32","description":"The page number to be retrieved. The default value is 1.","type":"integer"},"PerPage":{"format":"int32","description":"The number of records to be returned in a page. The default value is 10. Maximum allowed records per page are 100.","type":"integer"},"Order":{"description":"Whether you want to sort the records in ascending (Asc) or descending (Desc) order. The default sort order is ascending (Asc)","type":"string"},"SortColumn":{"format":"int32","description":"The field using which you would like to sort. Available options are:\r\n            0 = Product Code\r\n            1 =Product Name\r\n            2 = Nominal Code\r\n            default is 0 i.e., product code 0 = ProductCode,  1 = ProductName,  2 = NominalCode","enum":[0,1,2],"type":"integer"},"Filterbycharacter":{"description":"Provide this when you want to retrieve products whose name starts with given string.","type":"string"},"Filterbyinuseonly":{"description":"Flag to indicate whether to include in use products or all. Default is true i.e., in use products are retrieved","type":"boolean"}}},"KashFlow.Accounting.Model.Paging[KashFlow.Accounting.DTO.Product.ProductResponse]":{"required":["Data"],"type":"object","properties":{"MetaData":{"$ref":"#/definitions/KashFlow.Accounting.Model.PagingMetadata"},"Data":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Product.ProductResponse"}}}},"KashFlow.Accounting.DTO.Product.ProductUpdateRequest":{"required":["Code","Name","NominalCode"],"type":"object","properties":{"Code":{"type":"string"},"Name":{"type":"string"},"NominalCode":{"format":"int32","type":"integer"},"IsDefault":{"type":"boolean"},"AutoFillLineItem":{"type":"boolean"},"Price":{"format":"double","type":"number"},"WholeSalePrice":{"format":"double","type":"number"},"VATRate":{"format":"double","type":"number"},"VATExempt":{"type":"boolean"},"Description":{"type":"string"},"ManageStockLevel":{"type":"boolean"},"QuantityInStock":{"format":"int32","type":"integer"},"StockWarningQuantity":{"format":"int32","type":"integer"},"InUse":{"type":"boolean"},"IncrementStockLevelsOnPurchase":{"type":"boolean"},"CreateWhenNotPresent":{"type":"boolean"},"PurchaseNominalCode":{"format":"int32","type":"integer"},"PurchaseSubNominalCode":{"type":"string"},"ChangeNominalForRecurring":{"type":"boolean"}}},"KashFlow.Accounting.DTO.Product.ProductDetailsUpdateResponse":{"required":["NominalId","Code","Name","NominalCode"],"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"NominalId":{"format":"int64","type":"integer"},"Code":{"type":"string"},"Name":{"type":"string"},"NominalCode":{"format":"int32","type":"integer"},"IsDefault":{"type":"boolean"},"AutoFillLineItem":{"type":"boolean"},"Price":{"format":"double","type":"number"},"WholeSalePrice":{"format":"double","type":"number"},"VATRate":{"format":"double","type":"number"},"VATExempt":{"type":"boolean"},"Description":{"type":"string"},"ManageStockLevel":{"type":"boolean"},"QuantityInStock":{"format":"int32","type":"integer"},"StockWarningQuantity":{"format":"int32","type":"integer"},"InUse":{"type":"boolean"},"IncrementStockLevelsOnPurchase":{"type":"boolean"},"PurchaseNominalId":{"format":"int32","type":"integer"},"PurchaseSubNominalId":{"format":"int32","type":"integer"},"IsUsedInRecurringInvoice":{"type":"boolean"},"IsUsedInRecurringPurchase":{"type":"boolean"}}},"KashFlow.Accounting.Model.Reports.ProfitAndLossReport.ProfitAndLossReport":{"required":["ExcludeYearEnd","StartDate","EndDate","TurnoverTotal","CostOfSalesTotal","GrossProfitTotal","ExpensesTotal","NetProfitTotal"],"type":"object","properties":{"ExcludeYearEnd":{"type":"boolean"},"ProjectId":{"format":"int32","type":"integer"},"StartDate":{"type":"string"},"EndDate":{"type":"string"},"Turnover":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.ProfitAndLossReport.ProfitAndLossItem"}},"CostOfSales":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.ProfitAndLossReport.ProfitAndLossItem"}},"Expenses":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.ProfitAndLossReport.ProfitAndLossItem"}},"TurnoverTotal":{"format":"double","type":"number"},"CostOfSalesTotal":{"format":"double","type":"number"},"GrossProfitTotal":{"format":"double","type":"number"},"ExpensesTotal":{"format":"double","type":"number"},"NetProfitTotal":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.Reports.ProfitAndLossReport.ProfitAndLossItem":{"required":["NominalId","Code","Name","Amount"],"type":"object","properties":{"NominalId":{"format":"int32","type":"integer"},"Code":{"format":"int32","type":"integer"},"Name":{"type":"string"},"Amount":{"format":"double","type":"number"},"ImportDuty":{"format":"double","type":"number"},"ReportBreakdown":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.ReportBreakdownItem"}}}},"KashFlow.Accounting.Model.Reports.ProfitAndLossReport.MonthlyProfitLossRequest":{"required":["StartDate","EndDate"],"type":"object","properties":{"StartDate":{"type":"string"},"EndDate":{"type":"string"},"ProjectNumber":{"format":"int32","type":"integer"},"AccountingType":{"format":"int32","description":" 0 = Cash,  1 = Accrual","enum":[0,1],"type":"integer"}}},"KashFlow.Accounting.Model.Reports.ProfitAndLossReport.MonthlyProfitAndLoss":{"type":"object","properties":{"Month":{"type":"string"},"MonthlyProfitLoss":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.ProfitAndLossReport.ProfitLossDetails"}}},"KashFlow.Accounting.Model.Reports.ProfitAndLossReport.ProfitLossDetails":{"type":"object","properties":{"Turnover":{"format":"double","type":"number"},"GrossProfit":{"format":"double","type":"number"},"NetProfit":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.Reports.ProfitAndLossReportCsv.MonthlyProfitLossCsvRequest":{"required":["StartDate","EndDate"],"type":"object","properties":{"RoundOff":{"type":"boolean"},"StartDate":{"type":"string"},"EndDate":{"type":"string"},"ProjectNumber":{"format":"int32","type":"integer"},"AccountingType":{"format":"int32","description":" 0 = Cash,  1 = Accrual","enum":[0,1],"type":"integer"}}},"KashFlow.Accounting.Model.Reports.ProfitAndLossReportCsv.MonthlyProfitLossBreakdown":{"type":"object","properties":{"Month":{"type":"string"},"Breakdown":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.ProfitAndLossReportCsv.ProfitLossBreakdown"}}},"KashFlow.Accounting.Model.Reports.ProfitAndLossReportCsv.ProfitLossBreakdown":{"type":"object","properties":{"Turnover":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.ProfitAndLossReportCsv.NominalDetails"},"CostOfSales":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.ProfitAndLossReportCsv.NominalDetails"},"Expenses":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.ProfitAndLossReportCsv.NominalDetails"},"GrossProfit":{"format":"double","type":"number"},"NetProfit":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.Reports.ProfitAndLossReportCsv.NominalDetails":{"type":"object","properties":{"Nominals":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.ProfitAndLossReportCsv.ValuedNominal"}},"Total":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.Reports.ProfitAndLossReportCsv.ValuedNominal":{"type":"object","properties":{"Code":{"format":"int32","type":"integer"},"Name":{"type":"string"},"Value":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.ProjectListFilterParameters":{"type":"object","properties":{"Page":{"format":"int32","type":"integer"},"PerPage":{"format":"int32","type":"integer"},"Sort":{"format":"int32","description":" 0 = Asc,  1 = Desc","enum":[0,1],"type":"integer"},"SortBy":{"format":"int32","description":" 0 = Number,  1 = Name,  2 = Reference,  3 = Customer,  4 = Status,  5 = Margin,  6 = Id","enum":[0,1,2,3,4,5,6],"type":"integer"},"Status":{"type":"array","items":{"type":"string"}},"SearchText":{"type":"string"},"Number":{"format":"int32","type":"integer"},"Name":{"type":"string"},"Ref":{"type":"string"},"Description":{"type":"string"}}},"KashFlow.Accounting.Model.Paging[KashFlow.Accounting.DTO.Project.ProjectListResponse]":{"required":["Data"],"type":"object","properties":{"MetaData":{"$ref":"#/definitions/KashFlow.Accounting.Model.PagingMetadata"},"Data":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Project.ProjectListResponse"}}}},"KashFlow.Accounting.DTO.Project.ProjectListResponse":{"required":["Number","Name"],"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"ActualIncome":{"format":"double","type":"number"},"ActualExpenditure":{"format":"double","type":"number"},"Margin":{"format":"double","type":"number"},"Number":{"format":"int32","type":"integer"},"Name":{"type":"string"},"Reference":{"type":"string"},"Description":{"type":"string"},"Note":{"type":"string"},"Status":{"type":"string"},"StartDate":{"type":"string"},"EndDate":{"type":"string"},"CustomerCode":{"type":"string"}}},"KashFlow.Accounting.DTO.Project.ProjectRequest":{"required":["Number","Name"],"type":"object","properties":{"Number":{"format":"int32","type":"integer"},"Name":{"type":"string"},"Reference":{"type":"string"},"Description":{"type":"string"},"Note":{"type":"string"},"Status":{"type":"string"},"StartDate":{"type":"string"},"EndDate":{"type":"string"},"CustomerCode":{"type":"string"},"TargetSalesAmount":{"format":"double","type":"number"},"TargetPurchasesAmount":{"format":"double","type":"number"},"ExcludeVAT":{"type":"boolean"}}},"KashFlow.Accounting.DTO.Project.ProjectResponse":{"required":["Number","Name"],"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Number":{"format":"int32","type":"integer"},"Name":{"type":"string"},"Reference":{"type":"string"},"Description":{"type":"string"},"Note":{"type":"string"},"Status":{"type":"string"},"StartDate":{"type":"string"},"EndDate":{"type":"string"},"CustomerCode":{"type":"string"},"CustomerName":{"type":"string"},"TargetSalesAmount":{"format":"double","type":"number"},"AssociatedQuotesCount":{"format":"int32","type":"integer"},"TargetPurchasesAmount":{"format":"double","type":"number"},"ExcludeVAT":{"type":"boolean"},"ActualSalesAmount":{"format":"double","type":"number"},"ActualPurchasesAmount":{"format":"double","type":"number"},"ActualSalesVATAmount":{"format":"double","type":"number"},"ActualPurchasesVATAmount":{"format":"double","type":"number"},"ActualJournalsAmount":{"format":"double","type":"number"},"ActualBankTransactionAmount":{"format":"double","type":"number"},"WorkInProgressAmount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.UserSubscription.Promo":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"MonthlyPrice":{"format":"double","type":"number"},"IsNew":{"type":"boolean"},"ValidityInMonths":{"format":"int32","type":"integer"},"ExpiryDate":{"format":"int64","type":"integer"},"CanExpire":{"type":"boolean"},"Code":{"type":"string"},"Type":{"type":"string"},"FreePeriodDays":{"format":"int32","type":"integer"},"PackageName":{"type":"string"},"AppPackageId":{"format":"int32","type":"integer"},"IsLive":{"type":"boolean"},"DiscountAmount":{"format":"double","type":"number"},"MonthlyPriceVatAmount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.UserSubscription.SubscriptionInfo":{"type":"object","properties":{"AccountInformation":{"$ref":"#/definitions/KashFlow.Accounting.Model.UserSubscription.SubscriptionAccountInformation"},"SubscriptionPaymentInvoices":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.SubscriptionPaymentInvoice"}},"CardPaymentDetails":{"$ref":"#/definitions/KashFlow.Accounting.Model.UserSubscription.CardPaymentDetails"},"PartnerSettings":{"$ref":"#/definitions/KashFlow.Accounting.Model.UserSubscription.PartnerAssociatedSettings"},"SubscriptionCard":{"$ref":"#/definitions/KashFlow.Accounting.Model.UserSubscription.SubscriptionCard"}}},"KashFlow.Accounting.Model.UserSubscription.SubscriptionAccountInformation":{"type":"object","properties":{"ExpiryDate":{"format":"date-time","type":"string"},"PromoId":{"format":"int32","type":"integer"},"PromoCode":{"type":"string"},"Amount":{"format":"double","type":"number"},"StandardPriceOfCurrentActivePackage":{"format":"double","type":"number"},"OriginalSubscriptionDate":{"format":"date-time","type":"string"},"SubscriptionType":{"format":"int32","description":" 0 = Paid,  1 = FreeTrial","enum":[0,1],"type":"integer"},"ApplicationId":{"format":"int32","description":" 1 = RsrApp,  2 = OldWebApp,  3 = MobileIOS,  4 = MobileAndroid,  5 = KFConnect,  6 = IrisElementBookkeepingIOS,  7 = IrisElementBookkeepingAndroid","enum":[1,2,3,4,5,6,7],"type":"integer"},"SubscriptionPackageName":{"type":"string"},"IsExpired":{"type":"boolean"},"BuyItNowUserStatus":{"format":"byte","type":"string"},"IsSubscribed":{"type":"boolean"},"DowngradeSubscriptionPackageName":{"type":"string"},"DowngradeSubscriptionPackageSuffix":{"type":"string"},"DowngradeIOSPackageProductId":{"type":"string"},"SubscriptionPackageId":{"format":"int32","type":"integer"},"PromoExpiresDate":{"format":"date-time","type":"string"},"NewSubscriptionPackageId":{"format":"int32","type":"integer"},"CurrentPackageDurationInMonths":{"format":"byte","type":"string"},"ActiveFromDate":{"format":"date-time","type":"string"},"CanBuyServices":{"type":"boolean"},"CurrentPackageSuffix":{"type":"string"},"RepeatTrans":{"format":"int64","type":"integer"},"SubUsersCount":{"format":"int32","type":"integer"},"CurrenciesCount":{"format":"int32","type":"integer"},"RepeatInvoicesCount":{"format":"int32","type":"integer"},"DowngradePackageDurationInMonths":{"format":"byte","type":"string"},"IsNewPromo":{"type":"boolean"},"DowngradePackageId":{"format":"int32","type":"integer"},"MarketingPackageView":{"type":"string"},"CurrentPackageValue":{"format":"int32","type":"integer"},"CurrentPackagePrice":{"format":"double","type":"number"},"GracePeriodRetryStatus":{"format":"int32","type":"integer"},"CurrentPackageId":{"format":"int32","type":"integer"},"AppleProductId":{"type":"string"}}},"KashFlow.Accounting.Model.SubscriptionPaymentInvoice":{"type":"object","properties":{"InvoiceId":{"format":"int32","type":"integer"},"InvoiceNumber":{"format":"int32","type":"integer"},"InvoiceDate":{"format":"date-time","type":"string"},"InvoiceAmount":{"format":"double","type":"number"},"InvoiceKey":{"type":"string"}}},"KashFlow.Accounting.Model.UserSubscription.CardPaymentDetails":{"type":"object","properties":{"PaymentDetails":{"$ref":"#/definitions/KashFlow.Accounting.Model.Payment.PaymentDetails"},"VATRate":{"format":"double","type":"number"},"SaleType":{"type":"string"},"PaymentType":{"format":"int32","description":" 0 = PreAuthorize,  1 = Bill,  2 = Recurring","enum":[0,1,2],"type":"integer"},"ReCaptchaResponse":{"type":"string"},"CardPaymentResponse":{"$ref":"#/definitions/KashFlow.Accounting.Model.UserSubscription.CardPaymentResponse"},"IsPartner":{"type":"boolean"},"CompanyUserId":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.UserSubscription.PartnerAssociatedSettings":{"type":"object","properties":{"PartnerId":{"format":"int32","type":"integer"},"PartnerEmailAddress":{"type":"string"},"Telephone":{"type":"string"},"IsDirectPaymentEnabled":{"type":"boolean"},"HasAccessToSubscriptionPage":{"type":"boolean"},"RevenueSplit":{"format":"double","type":"number"},"PartnerCompany":{"type":"string"}}},"KashFlow.Accounting.Model.UserSubscription.SubscriptionCard":{"type":"object","properties":{"LastFourDigits":{"type":"string"},"CardExpiryWithFormat":{"type":"string"},"CardExpiry":{"type":"string"},"CardHolderName":{"type":"string"},"CardType":{"type":"string"}}},"KashFlow.Accounting.Model.UserSubscription.CardPaymentResponse":{"type":"object","properties":{"Success":{"type":"boolean"},"Message":{"type":"string"},"CrossReference":{"type":"string"},"ThreeDDetails":{"$ref":"#/definitions/KashFlow.Accounting.Model.UserSubscription.CardPaymentThreeDDetails"},"Transaction":{"$ref":"#/definitions/KashFlow.Accounting.Model.Transaction"},"RedirectUrl":{"type":"string"}}},"KashFlow.Accounting.Model.UserSubscription.CardPaymentThreeDDetails":{"type":"object","properties":{"PaReq":{"type":"string"},"AcsUrl":{"type":"string"},"MethodData":{"type":"string"},"CREQ":{"type":"string"}}},"KashFlow.Accounting.Model.Transaction":{"type":"object","properties":{"ID":{"format":"int32","type":"integer"},"Type":{"type":"string"},"Time":{"format":"date-time","type":"string"},"IP":{"type":"string"},"Amount":{"format":"double","type":"number"},"VAT":{"format":"double","type":"number"},"LastFourDigits":{"type":"string"},"Expiry":{"type":"string"},"Status":{"type":"string"},"ProtxID":{"type":"string"},"StatusDetail":{"type":"string"},"UserID":{"format":"int32","type":"integer"},"TxAuthNo":{"type":"string"},"Key":{"type":"string"},"IsPartner":{"type":"boolean"},"IsVoided":{"type":"boolean"},"SubscriberId":{"format":"int64","type":"integer"},"PartnerRevSplitID":{"format":"int32","type":"integer"},"PartnerRevSplitPercentage":{"format":"double","type":"number"},"AppPackageID":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.RestApi.Parameters.PurchaseFilterParameters":{"type":"object","properties":{"Page":{"format":"int32","description":"Page number. (default is 1)","type":"integer"},"PerPage":{"format":"int32","description":"PerPage is number of records per page. (default is 50)","type":"integer"},"Order":{"description":"Sorting order (asc or desc) (default is asc)","type":"string"},"SortBy":{"format":"int32","description":"Sort By column/field name. (default is Number) 0 = Number,  1 = SupplierReference,  2 = SupplierName,  3 = PurchaseDate,  4 = PaymentDueDate,  5 = GrossAmount,  6 = NetAmount,  7 = Status,  8 = PaidDate,  9 = DueAmount,  10 = Type,  11 = Project,  12 = VAT","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12],"type":"integer"},"FilterBy":{"description":"Status Filter","type":"string"},"ProjectNumber":{"format":"int32","description":"Project Number","type":"integer"},"SupplierCode":{"description":"Supplier code","type":"string"},"SearchText":{"description":"Search text","type":"string"},"Type":{"description":"Filter by type Purchase/Expense","type":"string"},"IssueDateFrom":{"description":"For issue date filter","type":"string"},"IssueDateTo":{"description":"For issue date filter","type":"string"},"Source":{"description":"Send \"MatchingEngine\" if request has been sent from matching engine otherwise empty(\"\")","type":"string"},"DoSearchWithDueAmount":{"description":"For search with due amount","type":"boolean"}}},"KashFlow.Accounting.Model.Paging[KashFlow.Accounting.DTO.Purchase.PurchaseListResponse]":{"required":["Data"],"type":"object","properties":{"MetaData":{"$ref":"#/definitions/KashFlow.Accounting.Model.PagingMetadata"},"Data":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Purchase.PurchaseListResponse"}}}},"KashFlow.Accounting.DTO.Purchase.PurchaseListResponse":{"type":"object","properties":{"Number":{"format":"int32","type":"integer"},"IssuedDate":{"type":"string"},"DueDate":{"type":"string"},"SupplierName":{"type":"string"},"SupplierCode":{"type":"string"},"SupplierReference":{"type":"string"},"ProjectGrossAmount":{"format":"double","type":"number"},"SupplierId":{"format":"int32","type":"integer"},"Id":{"format":"int32","type":"integer"},"PaidDate":{"type":"string"},"VATAmount":{"format":"double","type":"number"},"NetAmount":{"format":"double","type":"number"},"TotalPaidAmount":{"format":"double","type":"number"},"CISRCNetAmount":{"format":"double","type":"number"},"CISRCVatAmount":{"format":"double","type":"number"},"Status":{"type":"string"},"Currency":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Response.CurrencyResponse"},"HomeCurrencyGrossAmount":{"format":"double","type":"number"},"OverdueDays":{"format":"int32","type":"integer"},"ProjectNumber":{"format":"int32","type":"integer"},"ProjectName":{"type":"string"},"TradeBorderType":{"type":"string"},"FileCount":{"format":"int32","type":"integer"},"DueAmount":{"format":"double","type":"number"},"IsEmailSent":{"type":"boolean"},"VATReturnId":{"format":"int64","type":"integer"},"IsCISReverseCharge":{"type":"boolean"},"Type":{"type":"string"}}},"KashFlow.Accounting.DTO.Purchase.PurchaseRequest":{"type":"object","properties":{"Number":{"format":"int32","type":"integer"},"IssuedDate":{"type":"string"},"DueDate":{"type":"string"},"SupplierCode":{"type":"string"},"SupplierReference":{"type":"string"},"Currency":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Request.CurrencyRequest"},"LineItems":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Purchase.PurchaseLineItemBase"}},"PaymentLines":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Purchase.PurchasePaymentItemRequest"}},"ProjectNumber":{"format":"int32","type":"integer"},"AdditionalFieldValue":{"type":"string"},"IsCISReverseCharge":{"type":"boolean"},"Type":{"type":"string"}}},"KashFlow.Accounting.DTO.Purchase.PurchaseLineItemBase":{"type":"object","properties":{"ProjectNumber":{"format":"int32","type":"integer"},"NominalName":{"type":"string"},"ImportDuty":{"format":"double","type":"number"},"StockInfo":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Purchase.StockInfo"},"Number":{"format":"int32","type":"integer"},"Description":{"type":"string"},"Quantity":{"format":"double","type":"number"},"Rate":{"format":"double","type":"number"},"VATLevel":{"format":"double","type":"number"},"VATExempt":{"type":"boolean"},"VATAmount":{"format":"double","type":"number"},"NominalCode":{"format":"int32","type":"integer"},"ProductCode":{"type":"string"},"TaxCode":{"type":"string"},"Disallowed":{"type":"boolean"}}},"KashFlow.Accounting.DTO.Purchase.PurchasePaymentItemRequest":{"type":"object","properties":{"BankTransactionId":{"format":"int64","type":"integer"},"ResetBankReconciliation":{"type":"boolean"},"Id":{"format":"int64","type":"integer"},"Date":{"type":"string"},"BulkId":{"format":"int32","type":"integer"},"BFSTransactionId":{"format":"int64","type":"integer"},"PaymentProcessor":{"format":"int32","description":" 0 = NoCardPayments,  1 = SecureHosting,  2 = SagePay,  3 = IridiumCorp,  4 = Worldpay,  5 = ProcessingPoint,  6 = SagePaymentSolutions,  7 = SmartPay,  8 = AuthorizeDotNet,  9 = PayPalPro,  10 = PaymentSense,  11 = CardSave,  12 = CardStream,  14 = BarclayCardEPdq,  15 = GoCardless,  16 = McpePayPoint,  17 = GlobalPayments,  18 = EWayPayment,  19 = Stripe,  20 = BarclayCardEPdqExtraPlus,  21 = Square","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,14,15,16,17,18,19,20,21],"type":"integer"},"BankReconciliationId":{"format":"int32","type":"integer"},"AccountId":{"format":"int32","type":"integer"},"Note":{"type":"string"},"Method":{"format":"int64","type":"integer"},"Amount":{"format":"double","type":"number"}}},"KashFlow.Accounting.DTO.Purchase.StockInfo":{"type":"object","properties":{"Name":{"type":"string"},"QuantityInStock":{"format":"double","type":"number"},"ApplicableOn":{"type":"string"},"Received":{"type":"boolean"},"StockReceivedOn":{"type":"string"}}},"KashFlow.Accounting.DTO.Purchase.PurchaseResponse":{"type":"object","properties":{"Number":{"format":"int32","type":"integer"},"IssuedDate":{"type":"string"},"DueDate":{"type":"string"},"SupplierName":{"type":"string"},"SupplierCode":{"type":"string"},"SupplierReference":{"type":"string"},"GrossAmount":{"format":"double","type":"number"},"LineItems":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Purchase.PurchaseLineItemResponse"}},"PaymentLines":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Purchase.PurchasePaymentItemResponse"}},"Permalink":{"type":"string"},"AdditionalFieldValue":{"type":"string"},"PreviousNumber":{"format":"int32","type":"integer"},"NextNumber":{"format":"int32","type":"integer"},"IsWhtDeductionToBeApplied":{"type":"boolean"},"StockManagementApplicable":{"type":"boolean"},"Id":{"format":"int32","type":"integer"},"PaidDate":{"type":"string"},"VATAmount":{"format":"double","type":"number"},"NetAmount":{"format":"double","type":"number"},"TotalPaidAmount":{"format":"double","type":"number"},"CISRCNetAmount":{"format":"double","type":"number"},"CISRCVatAmount":{"format":"double","type":"number"},"Status":{"type":"string"},"Currency":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Response.CurrencyResponse"},"HomeCurrencyGrossAmount":{"format":"double","type":"number"},"OverdueDays":{"format":"int32","type":"integer"},"ProjectNumber":{"format":"int32","type":"integer"},"ProjectName":{"type":"string"},"TradeBorderType":{"type":"string"},"FileCount":{"format":"int32","type":"integer"},"DueAmount":{"format":"double","type":"number"},"IsEmailSent":{"type":"boolean"},"VATReturnId":{"format":"int64","type":"integer"},"IsCISReverseCharge":{"type":"boolean"},"Type":{"type":"string"}}},"KashFlow.Accounting.DTO.Purchase.PurchaseLineItemResponse":{"type":"object","properties":{"NominalId":{"format":"int32","type":"integer"},"ProductName":{"type":"string"},"HomeCurrencyRate":{"format":"double","type":"number"},"ProjectName":{"type":"string"},"HomeCurrencyImportDuty":{"format":"double","type":"number"},"DisableDisallowed":{"type":"boolean"},"ProjectNumber":{"format":"int32","type":"integer"},"NominalName":{"type":"string"},"ImportDuty":{"format":"double","type":"number"},"StockInfo":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Purchase.StockInfo"},"Number":{"format":"int32","type":"integer"},"Description":{"type":"string"},"Quantity":{"format":"double","type":"number"},"Rate":{"format":"double","type":"number"},"VATLevel":{"format":"double","type":"number"},"VATExempt":{"type":"boolean"},"VATAmount":{"format":"double","type":"number"},"NominalCode":{"format":"int32","type":"integer"},"ProductCode":{"type":"string"},"TaxCode":{"type":"string"},"Disallowed":{"type":"boolean"}}},"KashFlow.Accounting.DTO.Purchase.PurchasePaymentItemResponse":{"type":"object","properties":{"BulkPaymentNumber":{"format":"int32","type":"integer"},"Permalink":{"type":"string"},"PaymentProcessorEnumValue":{"format":"int32","description":" 0 = NoCardPayments,  1 = SecureHosting,  2 = SagePay,  3 = IridiumCorp,  4 = Worldpay,  5 = ProcessingPoint,  6 = SagePaymentSolutions,  7 = SmartPay,  8 = AuthorizeDotNet,  9 = PayPalPro,  10 = PaymentSense,  11 = CardSave,  12 = CardStream,  14 = BarclayCardEPdq,  15 = GoCardless,  16 = McpePayPoint,  17 = GlobalPayments,  18 = EWayPayment,  19 = Stripe,  20 = BarclayCardEPdqExtraPlus,  21 = Square","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,14,15,16,17,18,19,20,21],"type":"integer","readOnly":true},"IsPaymentCreditNote":{"type":"boolean"},"VATReturnId":{"format":"int64","type":"integer"},"Id":{"format":"int64","type":"integer"},"Date":{"type":"string"},"BulkId":{"format":"int32","type":"integer"},"BFSTransactionId":{"format":"int64","type":"integer"},"PaymentProcessor":{"format":"int32","description":" 0 = NoCardPayments,  1 = SecureHosting,  2 = SagePay,  3 = IridiumCorp,  4 = Worldpay,  5 = ProcessingPoint,  6 = SagePaymentSolutions,  7 = SmartPay,  8 = AuthorizeDotNet,  9 = PayPalPro,  10 = PaymentSense,  11 = CardSave,  12 = CardStream,  14 = BarclayCardEPdq,  15 = GoCardless,  16 = McpePayPoint,  17 = GlobalPayments,  18 = EWayPayment,  19 = Stripe,  20 = BarclayCardEPdqExtraPlus,  21 = Square","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,14,15,16,17,18,19,20,21],"type":"integer"},"BankReconciliationId":{"format":"int32","type":"integer"},"AccountId":{"format":"int32","type":"integer"},"Note":{"type":"string"},"Method":{"format":"int64","type":"integer"},"Amount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.PurchaseSummary":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Number":{"format":"int32","type":"integer"},"DueAmount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.Purchase":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Number":{"format":"int32","type":"integer"},"IssuedDate":{"type":"string"},"DueDate":{"type":"string"},"PaidDate":{"type":"string"},"VATAmount":{"format":"double","type":"number"},"NetAmount":{"format":"double","type":"number"},"TotalPaidAmount":{"format":"double","type":"number"},"CISRCNetAmount":{"format":"double","type":"number"},"CISRCVatAmount":{"format":"double","type":"number"},"IsCISReverseCharge":{"type":"boolean"},"Status":{"type":"string"},"GrossAmount":{"format":"double","type":"number"},"HomeCurrencyGrossAmount":{"format":"double","type":"number"},"ProjectGrossAmount":{"format":"double","type":"number"},"Currency":{"$ref":"#/definitions/KashFlow.Accounting.Model.Currency"},"LineItems":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.PurchaseLineItem"}},"PaymentLines":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Payment.PaymentItem"}},"SupplierId":{"format":"int32","type":"integer"},"SupplierCode":{"type":"string"},"SupplierReference":{"type":"string"},"SupplierName":{"type":"string"},"OverdueDays":{"format":"int32","type":"integer"},"ProjectNumber":{"format":"int32","type":"integer"},"ProjectName":{"type":"string"},"Permalink":{"type":"string"},"AdditionalFieldValue":{"type":"string"},"PreviousNumber":{"format":"int32","type":"integer"},"NextNumber":{"format":"int32","type":"integer"},"TradeBorderType":{"type":"string"},"IsWhtDeductionToBeApplied":{"type":"boolean"},"StockManagementApplicable":{"type":"boolean"},"FileCount":{"format":"int32","type":"integer"},"DueAmount":{"format":"double","type":"number"},"Type":{"type":"string"},"IsEmailSent":{"type":"boolean"},"VATReturnId":{"format":"int64","type":"integer"}}},"KashFlow.Accounting.Model.PurchaseLineItem":{"type":"object","properties":{"ProjectNumber":{"format":"int32","type":"integer"},"ProjectName":{"type":"string"},"NominalName":{"type":"string"},"StockInfo":{"$ref":"#/definitions/KashFlow.Accounting.Model.StockInfo"},"ImportDuty":{"format":"double","type":"number"},"HomeCurrencyImportDuty":{"format":"double","type":"number"},"Number":{"format":"int32","type":"integer"},"Description":{"type":"string"},"Quantity":{"format":"double","type":"number"},"Rate":{"format":"double","type":"number"},"HomeCurrencyRate":{"format":"double","type":"number"},"VATLevel":{"format":"double","type":"number"},"VATExempt":{"type":"boolean"},"VATAmount":{"format":"double","type":"number"},"HomeCurrencyVATAmount":{"format":"double","type":"number"},"NominalId":{"format":"int32","type":"integer"},"NominalCode":{"format":"int32","type":"integer"},"ProductCode":{"type":"string"},"ProductName":{"type":"string"},"TaxCode":{"type":"string"},"Disallowed":{"type":"boolean"},"DisableDisallowed":{"type":"boolean"}}},"KashFlow.Accounting.Model.Payment.PaymentItem":{"type":"object","properties":{"Id":{"format":"int64","type":"integer"},"AccountId":{"format":"int32","type":"integer"},"Date":{"type":"string"},"Note":{"type":"string"},"Method":{"format":"int64","type":"integer"},"Amount":{"format":"double","type":"number"},"BulkId":{"format":"int32","type":"integer"},"BulkPaymentNumber":{"format":"int32","type":"integer"},"Permalink":{"type":"string"},"BFSTransactionId":{"format":"int64","type":"integer"},"BankTransactionId":{"format":"int64","type":"integer"},"Reference":{"type":"string"},"PaymentProcessor":{"format":"int32","description":" 0 = NoCardPayments,  1 = SecureHosting,  2 = SagePay,  3 = IridiumCorp,  4 = Worldpay,  5 = ProcessingPoint,  6 = SagePaymentSolutions,  7 = SmartPay,  8 = AuthorizeDotNet,  9 = PayPalPro,  10 = PaymentSense,  11 = CardSave,  12 = CardStream,  14 = BarclayCardEPdq,  15 = GoCardless,  16 = McpePayPoint,  17 = GlobalPayments,  18 = EWayPayment,  19 = Stripe,  20 = BarclayCardEPdqExtraPlus,  21 = Square,  22 = IRISPay","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,14,15,16,17,18,19,20,21,22],"type":"integer"},"PaymentProcessorEnumValue":{"format":"int32","description":" 0 = NoCardPayments,  1 = SecureHosting,  2 = SagePay,  3 = IridiumCorp,  4 = Worldpay,  5 = ProcessingPoint,  6 = SagePaymentSolutions,  7 = SmartPay,  8 = AuthorizeDotNet,  9 = PayPalPro,  10 = PaymentSense,  11 = CardSave,  12 = CardStream,  14 = BarclayCardEPdq,  15 = GoCardless,  16 = McpePayPoint,  17 = GlobalPayments,  18 = EWayPayment,  19 = Stripe,  20 = BarclayCardEPdqExtraPlus,  21 = Square,  22 = IRISPay","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,14,15,16,17,18,19,20,21,22],"type":"integer","readOnly":true},"VATReturnId":{"format":"int64","type":"integer"},"IsExternalRefund":{"type":"boolean"},"IsPaymentCreditNote":{"type":"boolean"},"BankReconciliationId":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.StockInfo":{"type":"object","properties":{"Name":{"type":"string"},"QuantityInStock":{"format":"double","type":"number"},"ApplicableOn":{"type":"string"},"Received":{"type":"boolean"},"StockReceivedOn":{"type":"string"}}},"KashFlow.Accounting.Model.Base.PurchaseMassCreateStatus":{"type":"object","properties":{"BankTransactionId":{"format":"int64","type":"integer"},"ErrorCode":{"type":"string"},"Reason":{"type":"string"}}},"KashFlow.Accounting.Model.SourceAndDestination[System.Int32,System.Int32]":{"type":"object","properties":{"Source":{"format":"int32","type":"integer"},"Destination":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.PurchaseOptions":{"type":"object","properties":{"PreventDupeReceipts":{"type":"boolean"},"PermitNumberLabel":{"type":"string"},"PermitNumberEnabled":{"type":"boolean"}}},"KashFlow.Accounting.Model.BulkPurchaseRequest":{"type":"object","properties":{"BulkPurchaseInvoice":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.BulkPurchase"}}}},"KashFlow.Accounting.Model.BulkPurchase":{"type":"object","properties":{"Number":{"format":"int32","type":"integer"},"Type":{"format":"int32","description":" 0 = Purchase,  1 = Expense","enum":[0,1],"type":"integer"}}},"KashFlow.Accounting.RestApi.Parameters.PurchaseOrderFilterParameters":{"description":"Purchase Order Filter Parameters","type":"object","properties":{"Page":{"format":"int32","description":"Page number. (default is 1)","type":"integer"},"PerPage":{"format":"int32","description":"PerPage is number of records per page. (default is 50)","type":"integer"},"Order":{"description":"Sorting order (asc or desc) (default is asc)","type":"string"},"SortBy":{"description":"Sort By column/field name. (default is Number)","type":"string"},"ProjectNumber":{"format":"int32","description":"Project Number","type":"integer"},"SupplierCode":{"description":"Supplier Code","type":"string"},"CategoryNumber":{"format":"int32","description":"Purchase order Category Number","type":"integer"},"IssueDateFrom":{"description":"Issue Date From","type":"string"},"IssueDateTo":{"description":"Issue Date To","type":"string"},"SearchText":{"description":"Search Text by Purchase order's Number or Reference","type":"string"}}},"KashFlow.Accounting.Model.Paging[KashFlow.Accounting.DTO.PurchaseOrder.PurchaseOrderListResponse]":{"required":["Data"],"type":"object","properties":{"MetaData":{"$ref":"#/definitions/KashFlow.Accounting.Model.PagingMetadata"},"Data":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.PurchaseOrder.PurchaseOrderListResponse"}}}},"KashFlow.Accounting.DTO.PurchaseOrder.PurchaseOrderListResponse":{"type":"object","properties":{"Number":{"format":"int32","type":"integer"},"SupplierCode":{"type":"string"},"SupplierName":{"type":"string"},"Reference":{"type":"string"},"IssuedDate":{"type":"string"},"DeliveryDate":{"type":"string"},"NetAmount":{"format":"double","type":"number"},"GrossAmount":{"format":"double","type":"number"},"CustomerCode":{"type":"string"},"ProjectNumber":{"format":"int32","type":"integer"},"VATAmount":{"format":"double","type":"number"},"CustomerName":{"type":"string"},"IsEmailSent":{"type":"boolean"},"IsHomeCurrency":{"type":"boolean"},"FileCount":{"format":"int32","type":"integer"},"ProjectName":{"type":"string"},"Category":{"$ref":"#/definitions/KashFlow.Accounting.DTO.PurchaseOrder.PurchaseOrderCategory"},"TradeBorderType":{"type":"string"},"UseCustomDeliveryAddress":{"type":"boolean"}}},"KashFlow.Accounting.DTO.PurchaseOrder.PurchaseOrderCategory":{"type":"object","properties":{"Number":{"format":"int32","type":"integer"},"Name":{"type":"string"},"IconId":{"format":"int32","type":"integer"},"IconType":{"type":"string"},"IconColor":{"type":"string"}}},"KashFlow.Accounting.DTO.PurchaseOrder.PurchaseOrderRequest":{"type":"object","properties":{"Number":{"format":"int32","type":"integer"},"SupplierCode":{"type":"string"},"SupplierName":{"type":"string"},"Reference":{"type":"string"},"IssuedDate":{"type":"string"},"DeliveryDate":{"type":"string"},"NetAmount":{"format":"double","type":"number"},"GrossAmount":{"format":"double","type":"number"},"VATAmount":{"format":"double","type":"number"},"CustomerCode":{"type":"string"},"ProjectNumber":{"format":"int32","type":"integer"},"SuppressAmount":{"type":"boolean"},"SupplierAddress":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Request.AddressRequest"},"Currency":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Request.CurrencyRequest"},"DeliveryAddress":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Request.AddressRequest"},"IsHomeCurrency":{"type":"boolean"},"LineItems":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.PurchaseOrder.PurchaseOrderLineItemBase"}},"Category":{"$ref":"#/definitions/KashFlow.Accounting.DTO.PurchaseOrder.PurchaseOrderCategory"},"UseCustomDeliveryAddress":{"type":"boolean"}}},"KashFlow.Accounting.DTO.PurchaseOrder.PurchaseOrderLineItemBase":{"type":"object","properties":{"ImportDuty":{"format":"double","type":"number"},"HomeCurrencyImportDuty":{"format":"double","type":"number"},"HomeCurrencyRate":{"format":"double","type":"number"},"HomeCurrencyVATAmount":{"format":"double","type":"number"},"Number":{"format":"int32","type":"integer"},"Description":{"type":"string"},"Quantity":{"format":"double","type":"number"},"Rate":{"format":"double","type":"number"},"VATLevel":{"format":"double","type":"number"},"VATExempt":{"type":"boolean"},"VATAmount":{"format":"double","type":"number"},"NominalCode":{"format":"int32","type":"integer"},"ProductCode":{"type":"string"},"TaxCode":{"type":"string"},"Disallowed":{"type":"boolean"}}},"KashFlow.Accounting.DTO.PurchaseOrder.PurchaseOrderResponse":{"type":"object","properties":{"Number":{"format":"int32","type":"integer"},"SupplierCode":{"type":"string"},"SupplierName":{"type":"string"},"Reference":{"type":"string"},"IssuedDate":{"type":"string"},"DeliveryDate":{"type":"string"},"NetAmount":{"format":"double","type":"number"},"GrossAmount":{"format":"double","type":"number"},"CustomerCode":{"type":"string"},"ProjectNumber":{"format":"int32","type":"integer"},"SupplierAddress":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Response.AddressResponse"},"SuppressAmount":{"type":"boolean"},"Currency":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Response.CurrencyResponse"},"BillingAddress":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Response.AddressResponse"},"DeliveryAddress":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Response.AddressResponse"},"LineItems":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.PurchaseOrder.PurchaseOrderLineItemResponse"}},"PreviousNumber":{"format":"int32","type":"integer"},"NextNumber":{"format":"int32","type":"integer"},"Permalink":{"type":"string"},"VATAmount":{"format":"double","type":"number"},"CustomerName":{"type":"string"},"IsEmailSent":{"type":"boolean"},"IsHomeCurrency":{"type":"boolean"},"FileCount":{"format":"int32","type":"integer"},"ProjectName":{"type":"string"},"Category":{"$ref":"#/definitions/KashFlow.Accounting.DTO.PurchaseOrder.PurchaseOrderCategory"},"TradeBorderType":{"type":"string"},"UseCustomDeliveryAddress":{"type":"boolean"}}},"KashFlow.Accounting.DTO.PurchaseOrder.PurchaseOrderLineItemResponse":{"type":"object","properties":{"NominalName":{"type":"string"},"NominalId":{"format":"int32","type":"integer"},"ProductName":{"type":"string"},"ImportDuty":{"format":"double","type":"number"},"HomeCurrencyImportDuty":{"format":"double","type":"number"},"HomeCurrencyRate":{"format":"double","type":"number"},"HomeCurrencyVATAmount":{"format":"double","type":"number"},"Number":{"format":"int32","type":"integer"},"Description":{"type":"string"},"Quantity":{"format":"double","type":"number"},"Rate":{"format":"double","type":"number"},"VATLevel":{"format":"double","type":"number"},"VATExempt":{"type":"boolean"},"VATAmount":{"format":"double","type":"number"},"NominalCode":{"format":"int32","type":"integer"},"ProductCode":{"type":"string"},"TaxCode":{"type":"string"},"Disallowed":{"type":"boolean"}}},"KashFlow.Accounting.Model.PurchaseOrderCategory":{"required":["Number","Name","IconId"],"type":"object","properties":{"Number":{"format":"int32","type":"integer"},"Name":{"type":"string"},"IconId":{"format":"int32","type":"integer"},"IconType":{"type":"string"},"IconColor":{"type":"string"}}},"KashFlow.Accounting.Model.PurchaseOrderSetting":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Name":{"type":"string"},"Title":{"type":"string"},"DueDateValidFor":{"type":"string"},"DueDateValidForTitle":{"type":"string"},"Reference":{"type":"string"},"HideTotal":{"type":"boolean"},"DefaultCategoryNumber":{"format":"int32","type":"integer"},"CopyReferenceAs":{"format":"byte","type":"string"},"DeleteAfterConversion":{"type":"boolean"},"DefaultEmailTemplateNumber":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.Reports.PurchaseReport.UnallocatedSupplierPaymentReports.UnallocatedSupplierPaymentRequest":{"required":["StartDate","EndDate"],"type":"object","properties":{"SupplierCode":{"type":"string"},"StartDate":{"type":"string"},"EndDate":{"type":"string"}}},"KashFlow.Accounting.Model.UnallocatedSupplierPaymentReports":{"type":"object","properties":{"SupplierCode":{"type":"string"},"SupplierName":{"type":"string"},"TransactionId":{"format":"int32","type":"integer"},"BankAccountId":{"format":"int32","type":"integer"},"TransactionDate":{"type":"string"},"Amount":{"format":"double","type":"number"},"Comment":{"type":"string"}}},"KashFlow.Accounting.Model.Reports.PurchaseReport.ExpenditureReports.ExpenditureReportRequest":{"required":["StartDate","EndDate"],"type":"object","properties":{"ExpenditureBy":{"format":"int32","description":" 0 = None,  1 = Supplier,  2 = PurchaseCode,  3 = SubPurchaseCode,  4 = PurchaseCodeByMonth,  5 = Monthly","enum":[0,1,2,3,4,5],"type":"integer"},"BasedOn":{"format":"int32","description":" 0 = Issued,  1 = Paid","enum":[0,1],"type":"integer"},"ProjectId":{"format":"int32","type":"integer"},"NominalCode":{"format":"int32","type":"integer"},"IncludeExpenseSuppliers":{"type":"boolean"},"IncludeBankPayments":{"type":"boolean"},"StartDate":{"type":"string"},"EndDate":{"type":"string"}}},"KashFlow.Accounting.Model.Reports.PurchaseReport.ExpenditureByPaymentMethodReport.GetExpenditureByPaymentMethodReportRequest":{"required":["StartDate","EndDate"],"type":"object","properties":{"PaymentMethod":{"format":"int32","type":"integer"},"IncludeBankPayment":{"type":"boolean"},"PageNumber":{"format":"int32","type":"integer"},"PerPage":{"format":"int32","type":"integer"},"SortBy":{"format":"int32","description":" 0 = Date,  1 = Reference,  2 = Note,  3 = Amount,  4 = SupplierName,  5 = AccountNumber,  6 = SortCode","enum":[0,1,2,3,4,5,6],"type":"integer"},"OrderBy":{"type":"string"},"StartDate":{"type":"string"},"EndDate":{"type":"string"}}},"KashFlow.Accounting.Model.Paging[KashFlow.Accounting.Model.Reports.PurchaseReport.GetExpenditureByPaymentMethodReportResponse]":{"required":["Data"],"type":"object","properties":{"MetaData":{"$ref":"#/definitions/KashFlow.Accounting.Model.PagingMetadata"},"Data":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.PurchaseReport.GetExpenditureByPaymentMethodReportResponse"}}}},"KashFlow.Accounting.Model.Reports.PurchaseReport.GetExpenditureByPaymentMethodReportResponse":{"type":"object","properties":{"Date":{"type":"string"},"Reference":{"format":"int32","type":"integer"},"Supplier":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.PurchaseReport.SupplierDetails"},"Amount":{"format":"double","type":"number"},"PaymentNote":{"type":"string"},"AccountNumber":{"type":"string"},"SortCode":{"type":"string"}}},"KashFlow.Accounting.Model.Reports.PurchaseReport.SupplierDetails":{"type":"object","properties":{"Name":{"type":"string"},"Code":{"type":"string"}}},"KashFlow.Accounting.Model.Reports.PurchaseReport.SupplierReport.SupplierReportRequest":{"type":"object","properties":{"AllSuppliers":{"type":"boolean"},"IncludeArchivedSuppliers":{"type":"boolean"},"StartDate":{"type":"string"},"EndDate":{"type":"string"}}},"KashFlow.Accounting.Model.Reports.PurchaseReport.SupplierReport.SupplierReportResponse":{"type":"object","properties":{"Name":{"type":"string"},"AccountName":{"type":"string"},"AccountNumber":{"type":"string"},"AccountSortCode":{"type":"string"},"Code":{"type":"string"},"ContactName":{"type":"string"},"DefaultPurchaseCode":{"format":"int32","type":"integer"},"DefaultPurchaseCodeName":{"type":"string"},"EC":{"type":"boolean"},"Email":{"type":"string"},"Fax":{"type":"string"},"Mobile":{"type":"string"},"Notes":{"type":"string"},"PostCode":{"type":"string"},"Telephone":{"type":"string"},"TotalPaid":{"format":"double","type":"number"},"VatNumber":{"type":"string"},"Web":{"type":"string"},"Address":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.PurchaseReport.SupplierReport.Address"}}},"KashFlow.Accounting.Model.Reports.PurchaseReport.SupplierReport.Address":{"type":"object","properties":{"Address1":{"type":"string"},"Address2":{"type":"string"},"Address3":{"type":"string"},"Address4":{"type":"string"}}},"KashFlow.Accounting.Model.Reports.PurchaseReport.ExpenditureReportSubPurchaseCodeCsv.ExpenditureBySubPurchaseCodeCsvRequest":{"required":["StartDate","EndDate"],"type":"object","properties":{"BasedOn":{"format":"int32","description":" 0 = Issued,  1 = Paid","enum":[0,1],"type":"integer"},"ProjectNumber":{"format":"int32","type":"integer"},"StartDate":{"type":"string"},"EndDate":{"type":"string"}}},"KashFlow.Accounting.Model.Reports.PurchaseReport.ExpenditureReportSubPurchaseCodeCsv.ExpenditureBySubPurchaseCodeCsvResponse":{"type":"object","properties":{"ReceiptDetails":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.PurchaseReport.ExpenditureReportSubPurchaseCodeCsv.ReceiptDetails"}},"Total":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.Reports.PurchaseReport.ExpenditureReportSubPurchaseCodeCsv.ReceiptDetails":{"type":"object","properties":{"ReceiptDate":{"type":"string"},"ReceiptPaidDate":{"type":"string"},"ProductCode":{"type":"string"},"ProductName":{"type":"string"},"ReceiptNumber":{"format":"int32","type":"integer"},"ReceiptLineDescription":{"type":"string"},"SupplierCode":{"type":"string"},"SupplierName":{"type":"string"},"Quantity":{"format":"double","type":"number"},"Amount":{"format":"double","type":"number"}}},"KashFlow.Accounting.RestApi.Parameters.QuoteFilterParameters":{"type":"object","properties":{"Page":{"format":"int32","description":"Page number. (default is 1)","type":"integer"},"PerPage":{"format":"int32","description":"PerPage is number of records per page. (default is 50)","type":"integer"},"Order":{"description":"Sorting order (asc or desc) (default is asc)","type":"string"},"SortBy":{"description":"Sort By column/field name. (default is Number)","type":"string"},"CustomerCode":{"description":"Customer code","type":"string"},"CategoryNumber":{"format":"int32","description":"Quote Category Number","type":"integer"},"ProjectNumber":{"format":"int32","description":"Project Number","type":"integer"},"IssueDateTo":{"description":"For issue date filter","type":"string"},"IssueDateFrom":{"description":"For issue date filter","type":"string"},"SearchText":{"description":"Quote Reference","type":"string"}}},"KashFlow.Accounting.Model.Paging[KashFlow.Accounting.DTO.Quote.QuoteListResponse]":{"required":["Data"],"type":"object","properties":{"MetaData":{"$ref":"#/definitions/KashFlow.Accounting.Model.PagingMetadata"},"Data":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Quote.QuoteListResponse"}}}},"KashFlow.Accounting.DTO.Quote.QuoteListResponse":{"required":["Date","CustomerCode"],"type":"object","properties":{"Number":{"format":"int64","type":"integer"},"Date":{"type":"string"},"CustomerCode":{"type":"string"},"CustomerReference":{"type":"string"},"GrossAmount":{"format":"double","type":"number"},"ProjectNumber":{"format":"int32","type":"integer"},"Category":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Quote.QuoteCategoryList"},"CustomerId":{"format":"int32","type":"integer"},"CustomerName":{"type":"string"},"NetAmount":{"format":"double","type":"number"},"VATAmount":{"format":"double","type":"number"},"ProjectName":{"type":"string"},"FileCount":{"format":"int32","type":"integer"},"IsEmailSent":{"type":"boolean"}}},"KashFlow.Accounting.DTO.Quote.QuoteCategoryList":{"type":"object","properties":{"Number":{"format":"int32","type":"integer"},"Name":{"type":"string"},"IconType":{"type":"string"},"IconColor":{"type":"string"}}},"KashFlow.Accounting.DTO.Quote.QuoteRequest":{"required":["Date","CustomerCode"],"type":"object","properties":{"Number":{"format":"int64","type":"integer"},"Date":{"type":"string"},"CustomerCode":{"type":"string"},"CustomerReference":{"type":"string"},"GrossAmount":{"format":"double","type":"number"},"ProjectNumber":{"format":"int32","type":"integer"},"Category":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Quote.QuoteCategory"},"Currency":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Request.CurrencyRequest"},"LineItems":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Quote.QuoteLineItemBase"}},"SuppressAmount":{"type":"boolean"},"Addresses":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Request.AddressRequest"}},"DeliveryAddresses":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Request.DeliveryAddressRequest"}},"UseCustomDeliveryAddress":{"type":"boolean"}}},"KashFlow.Accounting.DTO.Quote.QuoteCategory":{"type":"object","properties":{"IconId":{"format":"int32","type":"integer"},"Number":{"format":"int32","type":"integer"},"Name":{"type":"string"},"IconType":{"type":"string"},"IconColor":{"type":"string"}}},"KashFlow.Accounting.DTO.Quote.QuoteLineItemBase":{"type":"object","properties":{"HomeCurrencyRate":{"format":"double","type":"number"},"HomeCurrencyVATAmount":{"format":"double","type":"number"},"Number":{"format":"int32","type":"integer"},"Description":{"type":"string"},"Quantity":{"format":"double","type":"number"},"Rate":{"format":"double","type":"number"},"VATLevel":{"format":"double","type":"number"},"VATExempt":{"type":"boolean"},"VATAmount":{"format":"double","type":"number"},"NominalCode":{"format":"int32","type":"integer"},"ProductCode":{"type":"string"},"TaxCode":{"type":"string"},"Disallowed":{"type":"boolean"}}},"KashFlow.Accounting.DTO.Quote.QuoteResponse":{"required":["Date","CustomerCode","Category","Currency","LineItems","Addresses","DeliveryAddresses"],"type":"object","properties":{"Number":{"format":"int64","type":"integer"},"Date":{"type":"string"},"CustomerCode":{"type":"string"},"CustomerReference":{"type":"string"},"GrossAmount":{"format":"double","type":"number"},"ProjectNumber":{"format":"int32","type":"integer"},"Category":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Quote.QuoteCategory"},"HomeCurrencyGrossAmount":{"format":"double","type":"number"},"Currency":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Response.CurrencyResponse"},"LineItems":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Quote.QuoteLineItemResponse"}},"SuppressAmount":{"type":"boolean"},"PreviousNumber":{"format":"int32","type":"integer"},"NextNumber":{"format":"int32","type":"integer"},"Permalink":{"type":"string"},"Addresses":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.CompanyDetails.Address"}},"DeliveryAddresses":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.DeliveryAddress"}},"UseCustomDeliveryAddress":{"type":"boolean"},"CustomerId":{"format":"int32","type":"integer"},"CustomerName":{"type":"string"},"NetAmount":{"format":"double","type":"number"},"VATAmount":{"format":"double","type":"number"},"ProjectName":{"type":"string"},"FileCount":{"format":"int32","type":"integer"},"IsEmailSent":{"type":"boolean"}}},"KashFlow.Accounting.DTO.Quote.QuoteLineItemResponse":{"type":"object","properties":{"ProductName":{"type":"string"},"HomeCurrencyRate":{"format":"double","type":"number"},"HomeCurrencyVATAmount":{"format":"double","type":"number"},"Number":{"format":"int32","type":"integer"},"Description":{"type":"string"},"Quantity":{"format":"double","type":"number"},"Rate":{"format":"double","type":"number"},"VATLevel":{"format":"double","type":"number"},"VATExempt":{"type":"boolean"},"VATAmount":{"format":"double","type":"number"},"NominalCode":{"format":"int32","type":"integer"},"ProductCode":{"type":"string"},"TaxCode":{"type":"string"},"Disallowed":{"type":"boolean"}}},"KashFlow.Accounting.Model.QuoteCategory":{"required":["Number","Name","IconId","IconType","IconColor"],"type":"object","properties":{"Number":{"format":"int32","type":"integer"},"Name":{"type":"string"},"IconId":{"format":"int32","type":"integer"},"IconType":{"type":"string"},"IconColor":{"type":"string"}}},"KashFlow.Accounting.DTO.Wrapper.QuoteCategoryWrapper":{"type":"object","properties":{"QuoteCategoryList":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.QuoteCategory"}}}},"KashFlow.Accounting.Model.Paging[KashFlow.Accounting.DTO.QuoteReportItem.QuoteReportItemResponse]":{"required":["Data"],"type":"object","properties":{"MetaData":{"$ref":"#/definitions/KashFlow.Accounting.Model.PagingMetadata"},"Data":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.QuoteReportItem.QuoteReportItemResponse"}}}},"KashFlow.Accounting.DTO.QuoteReportItem.QuoteReportItemResponse":{"required":["CustomerCode","CustomerName","QuoteNumber","DateInfo","QuoteDate"],"type":"object","properties":{"QuoteId":{"format":"int32","type":"integer"},"CustomerCode":{"type":"string"},"CustomerName":{"type":"string"},"QuoteNumber":{"format":"int64","type":"integer"},"CustomerReference":{"type":"string"},"DateInfo":{"format":"date-time","type":"string"},"QuoteDate":{"type":"string"},"Category":{"$ref":"#/definitions/KashFlow.Accounting.DTO.QuoteReportItem.QuoteCategory"},"VATTotalAmount":{"format":"double","type":"number"},"TotalAmount":{"format":"double","type":"number"}}},"KashFlow.Accounting.DTO.QuoteReportItem.QuoteCategory":{"required":["Number","Name"],"type":"object","properties":{"Number":{"format":"int32","type":"integer"},"Name":{"type":"string"}}},"KashFlow.Accounting.Model.ReceiptBankUser":{"type":"object","properties":{"UserName":{"type":"string"},"Email":{"type":"string"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"AddressLine1":{"type":"string"},"AddressLine2":{"type":"string"},"Town":{"type":"string"},"County":{"type":"string"},"PostCode":{"type":"string"},"CountryCode":{"type":"string"},"Mobile":{"type":"string"},"Phone":{"type":"string"},"Referral":{"type":"string"},"AccountantId":{"type":"string"},"Plan":{"type":"string"},"SubDomain":{"type":"string"},"CurrencyCode":{"type":"string"},"CompanyName":{"type":"string"},"AccountId":{"type":"string"},"ReferralCode":{"type":"string"},"AutoAuthKey":{"type":"string"},"IntegrationFailedAttempts":{"format":"int32","type":"integer"},"KashFlowPassword":{"type":"string"}}},"KashFlow.Accounting.RestApi.Parameters.RecurringBankTransactionFilterParameters":{"description":"The recurring bank transaction api filter parameters","type":"object","properties":{"Page":{"format":"int32","description":"Page number. (default is 1)","type":"integer"},"PerPage":{"format":"int32","description":"PerPage is number of records per page. (default is 50)","type":"integer"},"Order":{"description":"Sorting order (asc or desc)","type":"string"},"FilterBy":{"format":"int32","description":"Filter By 0 = All,  1 = Monthly,  2 = Annually,  3 = Weekly,  4 = MultiMonth,  5 = Periodically","enum":[0,1,2,3,4,5],"type":"integer"},"SortBy":{"format":"int32","description":"Sort By column/field name. (default is Number) 0 = Number,  1 = MoneyIn,  2 = MoneyOut,  3 = Comment,  4 = Project,  5 = Bank","enum":[0,1,2,3,4,5],"type":"integer"},"ProjectNumber":{"format":"int32","description":"Project Number","type":"integer"},"AccountId":{"format":"int32","description":"AccountId","type":"integer"},"SearchText":{"description":"Search text","type":"string"},"Archived":{"description":"For archived filter","type":"string"}}},"KashFlow.Accounting.Model.Paging[KashFlow.Accounting.Model.RecurringBankTransactionListResponse]":{"required":["Data"],"type":"object","properties":{"MetaData":{"$ref":"#/definitions/KashFlow.Accounting.Model.PagingMetadata"},"Data":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.RecurringBankTransactionListResponse"}}}},"KashFlow.Accounting.Model.RecurringBankTransactionListResponse":{"type":"object","properties":{"Number":{"format":"int32","type":"integer"},"Day":{"format":"int32","type":"integer"},"Comment":{"type":"string"},"BankName":{"type":"string"},"Frequency":{"$ref":"#/definitions/KashFlow.Accounting.Model.RecurringFrequency"},"MoneyIn":{"format":"double","type":"number"},"MoneyOut":{"format":"double","type":"number"},"ProjectName":{"type":"string"},"InvUntil":{"format":"int32","type":"integer"},"IsArchived":{"type":"boolean"}}},"KashFlow.Accounting.Model.RecurringFrequency":{"type":"object","properties":{"Type":{"type":"string"},"DayOfMonth":{"format":"int32","type":"integer"},"WeekDay":{"type":"string"},"Months":{"type":"array","items":{"type":"string"}},"StartDate":{"type":"string"},"Interval":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.RecurringBankTransaction":{"required":["Frequency","Duration"],"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Number":{"format":"int32","type":"integer"},"MoneyIn":{"format":"double","type":"number"},"MoneyOut":{"format":"double","type":"number"},"MoneyType":{"format":"int32","type":"integer"},"Comment":{"type":"string"},"Vatable":{"type":"boolean"},"VatRate":{"format":"double","type":"number"},"VatAmount":{"format":"double","type":"number"},"AccountId":{"format":"int32","type":"integer"},"ProjectNumber":{"format":"int32","type":"integer"},"Disallowed":{"type":"boolean"},"Frequency":{"$ref":"#/definitions/KashFlow.Accounting.Model.RecurringFrequency"},"Duration":{"$ref":"#/definitions/KashFlow.Accounting.Model.RecurringDuration"},"CustomerCode":{"type":"string"},"SupplierCode":{"type":"string"},"StartDate":{"type":"string"},"IsArchived":{"type":"boolean"}}},"KashFlow.Accounting.Model.RecurringDuration":{"type":"object","properties":{"Type":{"type":"string"},"RecurCount":{"format":"int32","type":"integer"},"TillSpecificDate":{"type":"string"}}},"KashFlow.Accounting.DTO.RecurringInvoice.RecurringInvoiceResponse":{"required":["StartDate","Number","Frequency","Duration"],"type":"object","properties":{"EmailTemplateNumber":{"format":"int32","type":"integer"},"EmailAutomatically":{"type":"boolean"},"StartDate":{"type":"string"},"InvoiceDetails":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringInvoice.RepeatInvoiceDetailsResponse"},"Currency":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Response.CurrencyResponse"},"HomeCurrencyGrossAmount":{"format":"double","type":"number"},"HomeCurrencyVATAmount":{"format":"double","type":"number"},"Number":{"format":"int32","type":"integer"},"Description":{"type":"string"},"Frequency":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringInvoice.RecurringFrequency"},"Duration":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringInvoice.RecurringDuration"},"UseLatestExchangeRate":{"type":"boolean"},"PreviousNumber":{"format":"int64","type":"integer"},"NextNumber":{"format":"int64","type":"integer"}}},"KashFlow.Accounting.DTO.RecurringInvoice.RepeatInvoiceDetailsResponse":{"required":["CustomerCode"],"type":"object","properties":{"CustomerId":{"format":"int32","type":"integer"},"CustomerCode":{"type":"string"},"CustomerReference":{"type":"string"},"CustomerName":{"type":"string"},"CustomerEmail":{"type":"string"},"GrossAmount":{"format":"double","type":"number"},"NetAmount":{"format":"double","type":"number"},"VATAmount":{"format":"double","type":"number"},"ProjectNumber":{"format":"int32","type":"integer"},"ProjectName":{"type":"string"},"LineItems":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringInvoice.RecurringInvoiceLineItemResponse"}},"PaymentDetails":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringInvoice.RecurringPaymentBase"},"Address":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Response.AddressResponse"}}},"KashFlow.Accounting.DTO.RecurringInvoice.RecurringFrequency":{"required":["DayOfMonth"],"type":"object","properties":{"Type":{"type":"string"},"DayOfMonth":{"format":"int32","type":"integer"},"WeekDay":{"type":"string"},"Months":{"type":"array","items":{"type":"string"}},"StartDate":{"type":"string"},"Interval":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.DTO.RecurringInvoice.RecurringDuration":{"required":["Type"],"type":"object","properties":{"Type":{"type":"string"},"RecurCount":{"format":"int32","type":"integer"},"TillSpecificDate":{"type":"string"}}},"KashFlow.Accounting.DTO.RecurringInvoice.RecurringInvoiceLineItemResponse":{"type":"object","properties":{"HomeCurrencyRate":{"format":"double","type":"number"},"HomeCurrencyVATAmount":{"format":"double","type":"number"},"ProductName":{"type":"string"},"DisableDisallowed":{"type":"boolean"},"ProjectNumber":{"format":"int32","type":"integer"},"Number":{"format":"int32","type":"integer"},"Description":{"type":"string"},"Quantity":{"format":"double","type":"number"},"Rate":{"format":"double","type":"number"},"VATLevel":{"format":"double","type":"number"},"VATExempt":{"type":"boolean"},"VATAmount":{"format":"double","type":"number"},"NominalCode":{"format":"int32","type":"integer"},"ProductCode":{"type":"string"},"TaxCode":{"type":"string"},"Disallowed":{"type":"boolean"}}},"KashFlow.Accounting.DTO.RecurringInvoice.RecurringPaymentBase":{"type":"object","properties":{"PaymentType":{"type":"string"},"AccountId":{"format":"int32","type":"integer"},"Note":{"type":"string"},"Method":{"format":"int64","type":"integer"},"Amount":{"format":"double","type":"number"}}},"KashFlow.Accounting.RestApi.Parameters.RecurringInvoiceFilterParameters":{"type":"object","properties":{"CustomerCode":{"description":"Customer code","type":"string"},"Page":{"format":"int32","description":"Page number. (default is 1)","type":"integer"},"PerPage":{"format":"int32","description":"PerPage is number of records per page. (default is 50)","type":"integer"},"Order":{"description":"Sorting order (asc or desc) (default is asc)","type":"string"},"FilterBy":{"description":"Filter data by \"Frequency\" column/field name\r\n            and the avilable values are (All, Monthly, Annually, Weekly, MultiMonth, Periodically) (default is All)","type":"string"},"SortBy":{"format":"int32","description":"Sort By column/field name. (default is Number) 0 = Number,  1 = NextDue,  2 = CustomerName,  3 = CustomerReference,  4 = Description,  5 = Expiry,  6 = GrossAmount,  7 = VATAmount,  8 = NetAmount,  9 = Project","enum":[0,1,2,3,4,5,6,7,8,9],"type":"integer"},"ProjectNumber":{"format":"int32","description":"Project Number","type":"integer"}}},"KashFlow.Accounting.Model.Paging[KashFlow.Accounting.DTO.RecurringInvoice.RecurringInvoiceListResponse]":{"required":["Data"],"type":"object","properties":{"MetaData":{"$ref":"#/definitions/KashFlow.Accounting.Model.PagingMetadata"},"Data":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringInvoice.RecurringInvoiceListResponse"}}}},"KashFlow.Accounting.DTO.RecurringInvoice.RecurringInvoiceListResponse":{"required":["InvoiceDetails","ExpiryDate","NextDueDate","Number","Frequency","Duration"],"type":"object","properties":{"InvoiceDetails":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringInvoice.RepeatInvoiceDeatilsListResponse"},"ExpiryDate":{"type":"string"},"NextDueDate":{"type":"string"},"Number":{"format":"int32","type":"integer"},"Description":{"type":"string"},"Frequency":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringInvoice.RecurringFrequency"},"Duration":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringInvoice.RecurringDuration"},"UseLatestExchangeRate":{"type":"boolean"},"PreviousNumber":{"format":"int64","type":"integer"},"NextNumber":{"format":"int64","type":"integer"}}},"KashFlow.Accounting.DTO.RecurringInvoice.RepeatInvoiceDeatilsListResponse":{"required":["CustomerCode"],"type":"object","properties":{"CustomerCode":{"type":"string"},"CustomerReference":{"type":"string"},"GrossAmount":{"format":"double","type":"number"},"NetAmount":{"format":"double","type":"number"},"VATAmount":{"format":"double","type":"number"},"CustomerId":{"format":"int32","type":"integer"},"CustomerName":{"type":"string"},"ProjectGrossAmount":{"format":"double","type":"number"},"ProjectName":{"type":"string"}}},"KashFlow.Accounting.DTO.RecurringInvoice.RecurringInvoiceRequest":{"required":["StartDate","InvoiceDetails","Number","Frequency","Duration"],"type":"object","properties":{"EmailTemplateNumber":{"format":"int32","type":"integer"},"EmailAutomatically":{"type":"boolean"},"StartDate":{"type":"string"},"RecurringInvoiceId":{"format":"int32","type":"integer"},"InvoiceDetails":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringInvoice.RepeatInvoiceDetailsRequest"},"Currency":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Request.CurrencyRequest"},"Number":{"format":"int32","type":"integer"},"Description":{"type":"string"},"Frequency":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringInvoice.RecurringFrequency"},"Duration":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringInvoice.RecurringDuration"},"UseLatestExchangeRate":{"type":"boolean"},"PreviousNumber":{"format":"int64","type":"integer"},"NextNumber":{"format":"int64","type":"integer"}}},"KashFlow.Accounting.DTO.RecurringInvoice.RepeatInvoiceDetailsRequest":{"required":["CustomerCode"],"type":"object","properties":{"CustomerCode":{"type":"string"},"CustomerReference":{"type":"string"},"GrossAmount":{"format":"double","type":"number"},"NetAmount":{"format":"double","type":"number"},"VATAmount":{"format":"double","type":"number"},"LineItems":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringInvoice.RecurringInvoiceLineItemBase"}},"PaymentDetails":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringInvoice.RecurringPaymentBase"},"ProjectNumber":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.DTO.RecurringInvoice.RecurringInvoiceLineItemBase":{"type":"object","properties":{"ProjectNumber":{"format":"int32","type":"integer"},"Number":{"format":"int32","type":"integer"},"Description":{"type":"string"},"Quantity":{"format":"double","type":"number"},"Rate":{"format":"double","type":"number"},"VATLevel":{"format":"double","type":"number"},"VATExempt":{"type":"boolean"},"VATAmount":{"format":"double","type":"number"},"NominalCode":{"format":"int32","type":"integer"},"ProductCode":{"type":"string"},"TaxCode":{"type":"string"},"Disallowed":{"type":"boolean"}}},"KashFlow.Accounting.RestApi.Parameters.RecurringInvoiceFilterParametersBase":{"type":"object","properties":{"Page":{"format":"int32","description":"Page number. (default is 1)","type":"integer"},"PerPage":{"format":"int32","description":"PerPage is number of records per page. (default is 50)","type":"integer"},"Order":{"description":"Sorting order (asc or desc) (default is asc)","type":"string"},"FilterBy":{"description":"Filter data by \"Frequency\" column/field name\r\n            and the avilable values are (All, Monthly, Annually, Weekly, MultiMonth, Periodically) (default is All)","type":"string"},"SortBy":{"format":"int32","description":"Sort By column/field name. (default is Number) 0 = Number,  1 = NextDue,  2 = CustomerName,  3 = CustomerReference,  4 = Description,  5 = Expiry,  6 = GrossAmount,  7 = VATAmount,  8 = NetAmount,  9 = Project","enum":[0,1,2,3,4,5,6,7,8,9],"type":"integer"},"ProjectNumber":{"format":"int32","description":"Project Number","type":"integer"}}},"KashFlow.Accounting.RestApi.Parameters.RecurringPurchaseFilterParameters":{"description":"The Recurring Purchase API Filter Parameters","type":"object","properties":{"Page":{"format":"int32","description":"Page number. (default is 1)","type":"integer"},"PerPage":{"format":"int32","description":"PerPage is number of records per page. (default is 50)","type":"integer"},"Order":{"description":"Sorting order (asc or desc)","type":"string"},"FilterBy":{"format":"int32","description":"Filter By 0 = All,  1 = Monthly,  2 = Annually,  3 = Weekly,  4 = MultiMonth,  5 = Periodically","enum":[0,1,2,3,4,5],"type":"integer"},"SortBy":{"format":"int32","description":"Sort By column/field name. (default is Number) 0 = Number,  1 = NextDue,  2 = SupplierName,  3 = SupplierReference,  4 = Comment,  5 = Amount,  6 = Expiry,  7 = VatAmount,  8 = NetAmount,  9 = Project","enum":[0,1,2,3,4,5,6,7,8,9],"type":"integer"},"SupplierCode":{"description":"Supplier code","type":"string"},"ProjectNumber":{"format":"int32","description":"Project Number","type":"integer"}}},"KashFlow.Accounting.Model.Paging[KashFlow.Accounting.DTO.RecurringPurchase.RecurringPurchaseListResponse]":{"required":["Data"],"type":"object","properties":{"MetaData":{"$ref":"#/definitions/KashFlow.Accounting.Model.PagingMetadata"},"Data":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringPurchase.RecurringPurchaseListResponse"}}}},"KashFlow.Accounting.DTO.RecurringPurchase.RecurringPurchaseListResponse":{"type":"object","properties":{"Number":{"format":"int32","type":"integer"},"Description":{"type":"string"},"PurchaseDetails":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringPurchase.RepeatPurchaseDetailsListResponse"},"ExpiryDate":{"type":"string"},"NextDueDate":{"type":"string"},"VatAmount":{"format":"double","type":"number"},"ProjectGrossAmount":{"format":"double","type":"number"},"ProjectName":{"type":"string"},"NetAmount":{"format":"double","type":"number"},"Frequency":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringInvoice.RecurringFrequency"},"Duration":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringInvoice.RecurringDuration"},"UseLatestExchangeRate":{"type":"boolean"},"PreviousNumber":{"format":"int64","type":"integer"},"NextNumber":{"format":"int64","type":"integer"}}},"KashFlow.Accounting.DTO.RecurringPurchase.RepeatPurchaseDetailsListResponse":{"type":"object","properties":{"SupplierId":{"format":"int32","type":"integer"},"SupplierName":{"type":"string"},"SupplierCode":{"type":"string"},"SupplierReference":{"type":"string"},"GrossAmount":{"format":"double","type":"number"}}},"KashFlow.Accounting.DTO.RecurringPurchase.RecurringPurchaseRequest":{"type":"object","properties":{"Number":{"format":"int32","type":"integer"},"Description":{"type":"string"},"PurchaseDetails":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringPurchase.RepeatPurchaseDetailsRequest"},"Currency":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Request.CurrencyRequest"},"Frequency":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringInvoice.RecurringFrequency"},"Duration":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringInvoice.RecurringDuration"},"UseLatestExchangeRate":{"type":"boolean"},"PreviousNumber":{"format":"int64","type":"integer"},"NextNumber":{"format":"int64","type":"integer"}}},"KashFlow.Accounting.DTO.RecurringPurchase.RepeatPurchaseDetailsRequest":{"type":"object","properties":{"SupplierCode":{"type":"string"},"SupplierReference":{"type":"string"},"ProjectNumber":{"format":"int32","type":"integer"},"LineItems":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringPurchase.RecurringPurchaseLineItemBase"}},"PaymentDetails":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringInvoice.RecurringPaymentBase"}}},"KashFlow.Accounting.DTO.RecurringPurchase.RecurringPurchaseLineItemBase":{"type":"object","properties":{"ProjectNumber":{"format":"int32","type":"integer"},"Number":{"format":"int32","type":"integer"},"Description":{"type":"string"},"Quantity":{"format":"double","type":"number"},"Rate":{"format":"double","type":"number"},"VATLevel":{"format":"double","type":"number"},"VATExempt":{"type":"boolean"},"VATAmount":{"format":"double","type":"number"},"NominalCode":{"format":"int32","type":"integer"},"ProductCode":{"type":"string"},"TaxCode":{"type":"string"},"Disallowed":{"type":"boolean"}}},"KashFlow.Accounting.DTO.RecurringPurchase.RecurringPurchaseResponse":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Number":{"format":"int32","type":"integer"},"Description":{"type":"string"},"PurchaseDetails":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringPurchase.RepeatPurchaseDetailsResponse"},"Currency":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Response.CurrencyResponse"},"HomeCurrencyGrossAmount":{"format":"double","type":"number"},"HomeCurrencyVATAmount":{"format":"double","type":"number"},"Frequency":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringInvoice.RecurringFrequency"},"Duration":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringInvoice.RecurringDuration"},"UseLatestExchangeRate":{"type":"boolean"},"PreviousNumber":{"format":"int64","type":"integer"},"NextNumber":{"format":"int64","type":"integer"}}},"KashFlow.Accounting.DTO.RecurringPurchase.RepeatPurchaseDetailsResponse":{"type":"object","properties":{"SupplierId":{"format":"int32","type":"integer"},"SupplierName":{"type":"string"},"SupplierCode":{"type":"string"},"SupplierReference":{"type":"string"},"NetAmount":{"format":"double","type":"number"},"VATAmount":{"format":"double","type":"number"},"GrossAmount":{"format":"double","type":"number"},"ProjectNumber":{"format":"int32","type":"integer"},"projectName":{"type":"string"},"LineItems":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringPurchase.RecurringPurchaseLineItemResponse"}},"PaymentDetails":{"$ref":"#/definitions/KashFlow.Accounting.DTO.RecurringInvoice.RecurringPaymentBase"},"Address":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Request.BillingAddressRequest"}}},"KashFlow.Accounting.DTO.RecurringPurchase.RecurringPurchaseLineItemResponse":{"type":"object","properties":{"HomeCurrencyRate":{"format":"double","type":"number"},"HomeCurrencyVATAmount":{"format":"double","type":"number"},"ProductName":{"type":"string"},"ProjectName":{"type":"string"},"DisableDisallowed":{"type":"boolean"},"ProjectNumber":{"format":"int32","type":"integer"},"Number":{"format":"int32","type":"integer"},"Description":{"type":"string"},"Quantity":{"format":"double","type":"number"},"Rate":{"format":"double","type":"number"},"VATLevel":{"format":"double","type":"number"},"VATExempt":{"type":"boolean"},"VATAmount":{"format":"double","type":"number"},"NominalCode":{"format":"int32","type":"integer"},"ProductCode":{"type":"string"},"TaxCode":{"type":"string"},"Disallowed":{"type":"boolean"}}},"KashFlow.Accounting.Model.Refund":{"required":["BaseInvoiceNumber","CreditInvoiceNumber"],"type":"object","properties":{"BaseInvoiceNumber":{"format":"int32","type":"integer"},"CreditInvoiceNumber":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.DTO.ReminderLetter.ReminderLetterBase":{"required":["Title","Text"],"type":"object","properties":{"Number":{"format":"int32","type":"integer"},"Title":{"type":"string"},"Text":{"type":"string"}}},"KashFlow.Accounting.DTO.ReminderLetter.ReminderLetterRequest":{"required":["SentVia","SentToEmailId"],"type":"object","properties":{"SentVia":{"type":"string"},"SentToEmailId":{"type":"string"}}},"KashFlow.Accounting.Model.ReportsListItem":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Name":{"type":"string"},"Url":{"type":"string"},"Category":{"type":"string"},"ShortDescription":{"type":"string"},"ReportType":{"type":"string"},"Favourite":{"type":"boolean"}}},"KashFlow.Accounting.Model.Reports.Settings.ReportsSettings":{"type":"object","properties":{"HideNominalCodes":{"type":"boolean"},"ShowDetailedBreakDownProfitAndLoss":{"type":"boolean"},"ShowDetailedBreakDownBalanceSheet":{"type":"boolean"},"ShowDetailedBreakDownAgedCreditors":{"type":"boolean"},"ShowDetailedBreakDownAgedDebtors":{"type":"boolean"},"ShowPercentageValuesInProfitAndLoss":{"type":"boolean"},"HideCodesWithZeroBalanceInTrialBalance":{"type":"boolean"},"HideMinorCurrencyUnits":{"type":"boolean"},"NegativeValueFormatting":{"type":"string"},"ShowNegativeValuesInRed":{"type":"boolean"},"ShowCompanyName":{"type":"boolean"},"ShowReportName":{"type":"boolean"},"ShowReportPeriod":{"type":"boolean"},"HeaderAlignment":{"type":"string"},"ShowLogo":{"type":"boolean"},"LogoAlignment":{"type":"string"},"Logo":{"type":"string"},"ShowDatePrepared":{"type":"boolean"},"DatePreparedAlignment":{"type":"string"},"ShowPageNumber":{"type":"boolean"},"PageNumberAlignment":{"type":"string"}}},"KashFlow.Accounting.DTO.Response.RoleResponse":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Name":{"type":"string"},"Description":{"type":"string"}}},"KashFlow.Accounting.Model.SalesAgent.SalesAgentSale":{"type":"object","properties":{"PartnerId":{"format":"int32","type":"integer"},"CrossReference":{"type":"string"},"AgentName":{"type":"string"},"CustomerCode":{"type":"string"},"InvoiceNumber":{"format":"int32","type":"integer"},"AuthorizationCode":{"type":"string"},"Amount":{"format":"double","type":"number"},"PurchasedCredit":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.SalesAgent.SalesAgentCredit"}},"Comments":{"type":"array","items":{"type":"string"}},"PartnerAddress":{"$ref":"#/definitions/KashFlow.Accounting.Model.BillingAddress"}}},"KashFlow.Accounting.Model.SalesAgent.SalesAgentCredit":{"type":"object","properties":{"SalesType":{"format":"int32","type":"integer"},"Description":{"type":"string"},"Quantity":{"format":"int32","type":"integer"},"CreditRate":{"format":"double","type":"number"},"VATRate":{"format":"double","type":"number"},"VATAmount":{"format":"double","type":"number"},"CreditsTotal":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.SalesAgent.SalesAgentResponse":{"type":"object","properties":{"Success":{"type":"boolean"},"Message":{"type":"string"},"KashFlowCustomerCode":{"type":"string"},"InvoiceNumber":{"format":"int32","type":"integer"},"InvoicePermaLink":{"type":"string"},"CrossReference":{"type":"string"},"AuthorizationCode":{"type":"string"},"TransactionID":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.Reports.Sales.UnallocatedCustomerPayment.UnallocatedCustomerPaymentRequest":{"required":["StartDate","EndDate"],"type":"object","properties":{"CustomerCode":{"type":"string"},"StartDate":{"type":"string"},"EndDate":{"type":"string"}}},"KashFlow.Accounting.Model.UnallocatedCustomerPaymentReports":{"type":"object","properties":{"CustomerCode":{"type":"string"},"CustomerName":{"type":"string"},"TransactionId":{"format":"int32","type":"integer"},"BankAccountId":{"format":"int32","type":"integer"},"TransactionDate":{"type":"string"},"Amount":{"format":"double","type":"number"},"Comment":{"type":"string"}}},"KashFlow.Accounting.Model.Reports.SalesReport.SalesInvoiceResponse":{"type":"object","properties":{"Metadata":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.SalesReport.InvoiceMetadata"},"Invoices":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.SalesReport.InvoiceResponse"}}}},"KashFlow.Accounting.Model.Reports.SalesReport.InvoiceMetadata":{"type":"object","properties":{"TotalOwed":{"format":"double","type":"number"},"TotalOwedExcludingTax":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.Reports.SalesReport.InvoiceResponse":{"type":"object","properties":{"InvoiceNumber":{"format":"int32","type":"integer"},"CustomerName":{"type":"string"},"CustomerCode":{"type":"string"},"InvoiceAmount":{"format":"double","type":"number"},"InvoiceAmountOwed":{"format":"double","type":"number"},"DueDate":{"format":"date-time","type":"string"},"OverdueBy":{"format":"int32","type":"integer"},"EmailLettersSent":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.SalesReport.EmailLetterSentDetailsResponse"}},"PartPayments":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.SalesReport.PartPaymentResponse"}}}},"KashFlow.Accounting.Model.Reports.SalesReport.EmailLetterSentDetailsResponse":{"type":"object","properties":{"Date":{"format":"date-time","type":"string"},"Description":{"type":"string"}}},"KashFlow.Accounting.Model.Reports.SalesReport.PartPaymentResponse":{"type":"object","properties":{"Date":{"format":"date-time","type":"string"},"PaymentAmount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.Reports.SalesReport.SalesCodeByMonthReport.SalesCodeByMonthRequest":{"type":"object","properties":{"StartDate":{"type":"string"},"EndDate":{"type":"string"},"Code":{"format":"int32","type":"integer"},"Show":{"format":"int32","description":" 0 = MoneyMode,  1 = UnitsSold","enum":[0,1],"type":"integer"}}},"KashFlow.Accounting.Model.Reports.SalesReport.SalesCodeByMonthReport.SalesCodeByMonthResponse":{"type":"object","properties":{"PeriodStart":{"type":"string"},"PeriodEnd":{"type":"string"},"Value":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.Reports.Sales.SaleIncome.SalesIncomeRequest":{"type":"object","properties":{"IncomeBy":{"format":"int32","description":" 0 = PaymentMethod,  1 = Customer,  2 = Source,  3 = Product,  4 = SalesType,  5 = All","enum":[0,1,2,3,4,5],"type":"integer"},"StartDate":{"type":"string"},"EndDate":{"type":"string"},"BasedOn":{"format":"int32","description":" 0 = Issued,  1 = Paid","enum":[0,1],"type":"integer"},"SourceId":{"format":"int32","type":"integer"},"ProjectId":{"format":"int32","type":"integer"},"IncludeBankPayments":{"type":"boolean"}}},"KashFlow.Accounting.Model.Reports.Sales.SaleIncome.SalesIncomeResponse":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Month":{"type":"string"},"Name":{"type":"string"},"Value":{"format":"double","type":"number"},"Code":{"type":"string"}}},"KashFlow.Accounting.Model.Reports.Sales.SalesHistory.SalesHistoryReuest":{"required":["StartDate","EndDate","NominalCode"],"type":"object","properties":{"StartDate":{"type":"string"},"EndDate":{"type":"string"},"NominalCode":{"format":"int32","type":"integer"},"ProductCode":{"type":"string"},"IncludeCustomerContactDetails":{"type":"boolean"}}},"KashFlow.Accounting.Model.Reports.Sales.SalesHistory.SalesHistoryResponse":{"type":"object","properties":{"InvoiceDate":{"type":"string"},"InvoiceNumber":{"format":"int32","type":"integer"},"CustomerCode":{"type":"string"},"CustomerName":{"type":"string"},"CustomerContact":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.Sales.SalesHistory.Address"},"PurchaseOrder":{"type":"string"},"NominalCode":{"format":"int32","type":"integer"},"NominalName":{"type":"string"},"ProductCode":{"type":"string"},"ProductName":{"type":"string"},"Quantity":{"format":"double","type":"number"},"Rate":{"format":"double","type":"number"},"Total":{"format":"double","type":"number"},"Description":{"type":"string"}}},"KashFlow.Accounting.Model.Reports.Sales.SalesHistory.Address":{"type":"object","properties":{"Address1":{"type":"string"},"Address2":{"type":"string"},"Address3":{"type":"string"},"Address4":{"type":"string"},"PostCode":{"type":"string"},"Telephone":{"type":"string"},"Email":{"type":"string"}}},"KashFlow.Accounting.Model.Reports.Sales.MonthlySales.MonthlySalesRequest":{"type":"object","properties":{"StartDate":{"type":"string"},"EndDate":{"type":"string"},"IncludeBankPayments":{"type":"boolean"}}},"KashFlow.Accounting.Model.Reports.Sales.MonthlySales.MonthlySalesResponse":{"type":"object","properties":{"Month":{"type":"string"},"SalesData":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.Sales.MonthlySales.MonthlySalesData"}},"TotalUnits":{"format":"double","type":"number"},"TotalValue":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.Reports.Sales.MonthlySales.MonthlySalesData":{"type":"object","properties":{"NominalCode":{"format":"int32","type":"integer"},"NominalName":{"type":"string"},"UnitsSold":{"format":"double","type":"number"},"Value":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.Reports.Sales.CustomerPurchaseHistory.CustomerPurchaseHistoryRequest":{"required":["StartDate","EndDate"],"type":"object","properties":{"StartDate":{"type":"string"},"EndDate":{"type":"string"},"CustomerCode":{"type":"string"}}},"KashFlow.Accounting.Model.Reports.Sales.CustomerPurchaseHistory.CustomerPurchaseHistoryResponse":{"type":"object","properties":{"InvoiceDate":{"type":"string"},"InvoiceNumber":{"format":"int32","type":"integer"},"PurchaseOrder":{"type":"string"},"NominalCode":{"format":"int32","type":"integer"},"NominalName":{"type":"string"},"ProductCode":{"type":"string"},"ProductName":{"type":"string"},"Quantity":{"format":"double","type":"number"},"Rate":{"format":"double","type":"number"},"Total":{"format":"double","type":"number"},"Description":{"type":"string"}}},"KashFlow.Accounting.Model.Reports.SalesReport.CustomerReport.CustomerReportRequest":{"type":"object","properties":{"Customer":{"format":"int32","description":" 0 = AllCustomers,  1 = CustomersInvoicedBetweenDates","enum":[0,1],"type":"integer"},"StartDate":{"type":"string"},"EndDate":{"type":"string"},"IncludeArchivedCustomers":{"type":"boolean"}}},"KashFlow.Accounting.Model.Reports.SalesReport.CustomerReport.CustomerReportResponse":{"required":["Data"],"type":"object","properties":{"MetaData":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.SalesReport.CustomerReport.CustomerCustomLabels"},"Data":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.SalesReport.CustomerReport.CustomerReport"}}}},"KashFlow.Accounting.Model.Reports.SalesReport.CustomerReport.CustomerCustomLabels":{"type":"object","properties":{"CustText1":{"type":"string"},"CustText2":{"type":"string"},"CustText3":{"type":"string"},"CustText4":{"type":"string"},"CustText5":{"type":"string"},"CustText6":{"type":"string"},"CustText7":{"type":"string"},"CustText8":{"type":"string"},"CustText9":{"type":"string"},"CustText10":{"type":"string"},"CustText11":{"type":"string"},"CustText12":{"type":"string"},"CustText13":{"type":"string"},"CustText14":{"type":"string"},"CustText15":{"type":"string"},"CustText16":{"type":"string"},"CustText17":{"type":"string"},"CustText18":{"type":"string"},"CustText19":{"type":"string"},"CustText20":{"type":"string"},"CustCheck1":{"type":"string"},"CustCheck2":{"type":"string"},"CustCheck3":{"type":"string"},"CustCheck4":{"type":"string"},"CustCheck5":{"type":"string"},"CustCheck6":{"type":"string"},"CustCheck7":{"type":"string"},"CustCheck8":{"type":"string"},"CustCheck9":{"type":"string"},"CustCheck10":{"type":"string"},"CustCheck11":{"type":"string"},"CustCheck12":{"type":"string"},"CustCheck13":{"type":"string"},"CustCheck14":{"type":"string"},"CustCheck15":{"type":"string"},"CustCheck16":{"type":"string"},"CustCheck17":{"type":"string"},"CustCheck18":{"type":"string"},"CustCheck19":{"type":"string"},"CustCheck20":{"type":"string"}}},"KashFlow.Accounting.Model.Reports.SalesReport.CustomerReport.CustomerReport":{"type":"object","properties":{"CustomerCode":{"type":"string"},"CustomerName":{"type":"string"},"CustomerContact":{"type":"string"},"CustomerContactTitle":{"type":"string"},"CustomerContactFirstName":{"type":"string"},"CustomerContactLastName":{"type":"string"},"CustomerAddress1":{"type":"string"},"CustomerAddress2":{"type":"string"},"CustomerAddress3":{"type":"string"},"CustomerAddress4":{"type":"string"},"CustomerPostCode":{"type":"string"},"CustomerCountry":{"type":"string"},"CustomerTelephone":{"type":"string"},"CustomerFax":{"type":"string"},"CustomerMobile":{"type":"string"},"CustomerWebsite":{"type":"string"},"CustomerEmail":{"type":"string"},"VATNumber":{"type":"string"},"TotalPaid":{"format":"double","type":"number"},"CustomerNotes":{"type":"string"},"DefaultSalesCode":{"format":"int32","type":"integer"},"DefaultSalesCodeName":{"type":"string"},"InvoicesCount":{"format":"int32","type":"integer"},"SourceName":{"type":"string"},"PaymentTerms":{"format":"int32","type":"integer"},"CustomerDiscount":{"format":"double","type":"number"},"WholesalePricing":{"type":"string"},"DeliveryAddress1":{"type":"string"},"DeliveryAddress2":{"type":"string"},"DeliveryAddress3":{"type":"string"},"DeliveryAddress4":{"type":"string"},"DeliveryPostCode":{"type":"string"},"FirstInvoiced":{"format":"date-time","type":"string"},"LastInvoiced":{"format":"date-time","type":"string"},"GoCardlessMandate":{"type":"string"},"CustomerCustomValues":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.SalesReport.CustomerReport.CustomerCustomValues"},"UniqueEntityNumber":{"type":"string"}}},"KashFlow.Accounting.Model.Reports.SalesReport.CustomerReport.CustomerCustomValues":{"type":"object","properties":{"CustText1":{"type":"string"},"CustText2":{"type":"string"},"CustText3":{"type":"string"},"CustText4":{"type":"string"},"CustText5":{"type":"string"},"CustText6":{"type":"string"},"CustText7":{"type":"string"},"CustText8":{"type":"string"},"CustText9":{"type":"string"},"CustText10":{"type":"string"},"CustText11":{"type":"string"},"CustText12":{"type":"string"},"CustText13":{"type":"string"},"CustText14":{"type":"string"},"CustText15":{"type":"string"},"CustText16":{"type":"string"},"CustText17":{"type":"string"},"CustText18":{"type":"string"},"CustText19":{"type":"string"},"CustText20":{"type":"string"},"CustCheck1":{"type":"boolean"},"CustCheck2":{"type":"boolean"},"CustCheck3":{"type":"boolean"},"CustCheck4":{"type":"boolean"},"CustCheck5":{"type":"boolean"},"CustCheck6":{"type":"boolean"},"CustCheck7":{"type":"boolean"},"CustCheck8":{"type":"boolean"},"CustCheck9":{"type":"boolean"},"CustCheck10":{"type":"boolean"},"CustCheck11":{"type":"boolean"},"CustCheck12":{"type":"boolean"},"CustCheck13":{"type":"boolean"},"CustCheck14":{"type":"boolean"},"CustCheck15":{"type":"boolean"},"CustCheck16":{"type":"boolean"},"CustCheck17":{"type":"boolean"},"CustCheck18":{"type":"boolean"},"CustCheck19":{"type":"boolean"},"CustCheck20":{"type":"boolean"}}},"KashFlow.Accounting.Model.Reports.SalesReport.IncomeReport.IncomeReportByRequestBase":{"type":"object","properties":{"StartDate":{"type":"string"},"EndDate":{"type":"string"},"BasedOn":{"format":"int32","description":" 0 = Issued,  1 = Paid","enum":[0,1],"type":"integer"},"SourceId":{"format":"int32","type":"integer"},"ProjectId":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.Reports.SalesReport.IncomeReportByProductCSV.IncomeReportByProductCsvResponse":{"type":"object","properties":{"ProductCode":{"type":"string"},"ProductName":{"type":"string"},"Date":{"type":"string"},"SalesTypeCode":{"type":"string"},"SaleTypeName":{"type":"string"},"InvoiceNumber":{"format":"int32","type":"integer"},"Description":{"type":"string"},"CustomerCode":{"type":"string"},"CustomerName":{"type":"string"},"ProjectNumber":{"format":"int32","type":"integer"},"ProjectName":{"type":"string"},"Quantity":{"format":"double","type":"number"},"Amount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.Reports.SalesReport.IncomeReport.IncomeReportByResponseBase":{"type":"object","properties":{"Date":{"type":"string"},"SalesTypeCode":{"type":"string"},"SaleTypeName":{"type":"string"},"InvoiceNumber":{"format":"int32","type":"integer"},"Description":{"type":"string"},"CustomerCode":{"type":"string"},"CustomerName":{"type":"string"},"ProjectNumber":{"format":"int32","type":"integer"},"ProjectName":{"type":"string"},"Quantity":{"format":"double","type":"number"},"Amount":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.Reports.SalesReport.SaleIncomeReports.SalesIncomeCsvResponse":{"type":"object","properties":{"Method":{"type":"string"},"InvoiceDetails":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.SalesReport.SaleIncomeReports.InvoiceDetails"}},"Total":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.Reports.SalesReport.SaleIncomeReports.InvoiceDetails":{"type":"object","properties":{"InvoicePaidDate":{"type":"string"},"InvoiceIssueDate":{"type":"string"},"InvoiceNumber":{"format":"int32","type":"integer"},"CustomerCode":{"type":"string"},"CustomerName":{"type":"string"},"InvoiceAmount":{"format":"double","type":"number"},"InvoicePaidNote":{"type":"string"}}},"KashFlow.Accounting.Model.GlobalSearchRequest":{"required":["SearchText","SearchEntityType"],"type":"object","properties":{"SearchText":{"type":"string"},"SearchEntityType":{"type":"string"},"ExactMatch":{"type":"boolean"},"StartDate":{"format":"int64","maximum":99991231,"minimum":10000101,"type":"integer"},"EndDate":{"format":"int64","maximum":99991231,"minimum":10000101,"type":"integer"},"PageNumber":{"format":"int32","type":"integer"},"PerPage":{"format":"int32","type":"integer"},"SortOrder":{"format":"int32","description":" 0 = Asc,  1 = Desc","enum":[0,1],"type":"integer"}}},"KashFlow.Accounting.Model.GlobalSearch.GlobalSearchResult":{"type":"object","properties":{"TotalRecords":{"format":"int32","type":"integer"},"GlobalSearchResponse":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.GlobalSearchResponse"}}}},"KashFlow.Accounting.Model.GlobalSearchResponse":{"type":"object","properties":{"EntityType":{"format":"int32","description":" 0 = All,  1 = Invoice,  2 = Purchase,  3 = Bank,  4 = Journal,  5 = InvoicePayment,  6 = PurchasePayment,  7 = Customer,  8 = Supplier,  9 = Quote,  10 = BulkPayments,  11 = Expense,  12 = Trip,  13 = PurchaseOrder","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,13],"type":"integer"},"EntityTypeText":{"type":"string"},"TotalEntityCount":{"format":"int32","type":"integer"},"EntityDetails":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.SearchResult"}}}},"KashFlow.Accounting.Model.SearchResult":{"type":"object","properties":{"EntityId":{"format":"int32","type":"integer"},"Date":{"type":"string"},"Reference":{"type":"string"},"EntityUrl":{"type":"string"},"EntityUri":{"type":"string"},"ResourceId":{"format":"int32","type":"integer"},"ResourceName":{"type":"string"},"ResourceUrl":{"type":"string"},"ResourceUri":{"type":"string"}}},"KashFlow.Accounting.Model.Settings.ProjectSettingsRequest":{"type":"object","properties":{"ProjectText":{"type":"string"},"IsEnabled":{"type":"boolean"},"ProjectPrint":{"type":"boolean"},"ProjectOnPurchaseLine":{"type":"boolean"},"ProjectOnInvoiceLine":{"type":"boolean"},"ProjectOnBankLine":{"type":"boolean"},"ProjectOnJournalLine":{"type":"boolean"},"ProjectStartDateName":{"type":"string"},"ProjectEndDateName":{"type":"string"},"IsWorkInProgressEnabled":{"type":"boolean"},"IsCustomerEnabled":{"type":"boolean"},"OrderBy":{"type":"string"},"Order":{"type":"string"}}},"KashFlow.Accounting.Model.Settings.ProjectSettings":{"type":"object","properties":{"ProjectText":{"type":"string"},"IsEnabled":{"type":"boolean"},"ProjectPrint":{"type":"boolean"},"ProjectOnPurchaseLine":{"type":"boolean"},"ProjectOnInvoiceLine":{"type":"boolean"},"ProjectOnBankLine":{"type":"boolean"},"ProjectOnJournalLine":{"type":"boolean"},"ProjectStartDateName":{"type":"string"},"ProjectEndDateName":{"type":"string"},"IsWorkInProgressEnabled":{"type":"boolean"},"IsCustomerEnabled":{"type":"boolean"},"OrderBy":{"type":"string"},"Order":{"type":"string"}}},"KashFlow.Accounting.Model.Settings.APISettings":{"type":"object","properties":{"APIEnabled":{"type":"boolean"},"RESTAPIEnabled":{"type":"boolean"},"AutoAuthEnabled":{"type":"boolean"},"AutoAuthKey":{"type":"string"},"AccessToSpecificIPAddressesOnly":{"type":"boolean"},"UseSeparateSOAPAPIPassword":{"type":"boolean"},"EnableRemoteLogin":{"type":"boolean"},"Password":{"type":"string"},"PasswordChanged":{"type":"boolean"}}},"KashFlow.Accounting.Model.Settings.GoCardlessSettings":{"type":"object","properties":{"DirectDebitDoneMessage":{"type":"string"},"IsDirectDebitDoneRedirect":{"type":"boolean"},"DirectDebitDoneRedirectUrl":{"type":"string"},"SetupEmailSubject":{"type":"string"},"SetupEmailBody":{"type":"string"},"BankAccountID":{"format":"int32","type":"integer"},"PayMethod":{"format":"int32","type":"integer"},"IsRecordWithdrawals":{"type":"boolean"},"WithdrawToAccountID":{"format":"int32","type":"integer"},"WithdrawFeeNominalID":{"format":"int32","type":"integer"},"IsDefaultPaymentProcessor":{"type":"boolean"},"MandateCount":{"format":"int32","type":"integer"},"VerificationStatus":{"type":"string"},"ExemptVATOnFee":{"type":"boolean"}}},"KashFlow.Accounting.Model.Settings.MileageSettings":{"type":"object","properties":{"IsEnabled":{"type":"boolean"},"IncludeInSA103":{"type":"boolean"},"ClaimVAT":{"type":"boolean"},"DefaultVehicleTypeId":{"format":"byte","type":"string"},"DefaultEngineTypeId":{"format":"byte","type":"string"},"DefaultEngineSizeId":{"format":"byte","type":"string"},"DefaultNominalCode":{"format":"int32","type":"integer"},"DefaultOutOfPocketExpenseNominalCode":{"format":"int32","type":"integer"},"CreateDefaultOutOfPocketExpenseNominalCode":{"type":"boolean"},"CreateDefaultNominalCode":{"type":"boolean"},"Rates":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Mileage.MileageRates"}}}},"KashFlow.Accounting.Model.Mileage.MileageRates":{"type":"object","properties":{"RateFrom":{"format":"date-time","type":"string"},"Threshold":{"format":"int32","type":"integer"},"FourWheelerBelowThreshold":{"format":"double","type":"number"},"FourWheelerAfterThreshold":{"format":"double","type":"number"},"TwoWheeler":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.Settings.UserProfile":{"type":"object","properties":{"Username":{"type":"string"},"Name":{"type":"string"},"EmailId":{"type":"string"},"CompanyName":{"type":"string"}}},"KashFlow.Accounting.DTO.Settings.ProfileUpdateRequest":{"type":"object","properties":{"Name":{"type":"string"},"EmailId":{"type":"string"}}},"KashFlow.Accounting.DTO.Signup.SignupUserBase":{"type":"object","properties":{"EmailAddress":{"type":"string"},"Telephone":{"type":"string"},"PromoCode":{"type":"string"},"IsBuyItNow":{"type":"boolean"},"AcceptedTermsAndConditions":{"type":"boolean"},"IsEmailAddressInvalid":{"type":"boolean"},"IsEmailAddressInUse":{"type":"boolean"}}},"KashFlow.Accounting.DTO.Signup.SignupResponse":{"type":"object","properties":{"ResendActivationLinkGUID":{"type":"string"},"AcceptedTermsAndConditions":{"type":"boolean"},"IsTelephoneEmpty":{"type":"boolean"},"IsEmailAddressEmpty":{"type":"boolean"},"TelephoneLessThanEightDigit":{"type":"boolean"},"TelephoneNotNumeric":{"type":"boolean"},"PromoDoesNotExists":{"type":"boolean"},"TermsAndConditionsNotAccepted":{"type":"boolean"},"PromoNotForBuyItNow":{"type":"boolean"},"IsEmailAddressInvalid":{"type":"boolean"},"IsEmailAddressInUse":{"type":"boolean"}}},"KashFlow.Accounting.DTO.Signup.ActivationLinkDetails":{"type":"object","properties":{"EmailAddress":{"type":"string"},"Telephone":{"type":"string"},"IsPromoCodeExpired":{"type":"boolean"}}},"KashFlow.Accounting.DTO.Signup.ActivationLinkDetailedResponse":{"type":"object","properties":{"ResendActivationLinkGUID":{"type":"string"},"IsActivationLinkGUIDExpired":{"type":"boolean"},"IsPromoCodeExpired":{"type":"boolean"}}},"KashFlow.Accounting.DTO.Signup.SignupRequest":{"type":"object","properties":{"ResendActivationLinkGUID":{"type":"string"}}},"KashFlow.Accounting.DTO.Signup.SignupCredentialsRequest":{"type":"object","properties":{"Password":{"type":"string"},"ConfirmPassword":{"type":"string"},"MemorableWord":{"type":"string"},"ConfirmMemorableWord":{"type":"string"},"ActivationLinkGUID":{"type":"string"}}},"KashFlow.Accounting.DTO.Signup.IrisUserSignupRequest":{"type":"object","properties":{"EmailAddress":{"type":"string"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"Telephone":{"type":"string"},"PromoCode":{"type":"string"},"AcceptedTermsAndConditions":{"type":"boolean"}}},"KashFlow.Accounting.DTO.Signup.IrisUserSignupResponse":{"type":"object","properties":{"IsFirstNameInvalid":{"type":"boolean"},"IsLastNameInvalid":{"type":"boolean"},"IsUserCreatedInOkta":{"type":"boolean"},"IsUserCreatedInKashFlow":{"type":"boolean"},"ResendActivationLinkGUID":{"type":"string"},"AcceptedTermsAndConditions":{"type":"boolean"},"IsTelephoneEmpty":{"type":"boolean"},"IsEmailAddressEmpty":{"type":"boolean"},"TelephoneLessThanEightDigit":{"type":"boolean"},"TelephoneNotNumeric":{"type":"boolean"},"PromoDoesNotExists":{"type":"boolean"},"TermsAndConditionsNotAccepted":{"type":"boolean"},"PromoNotForBuyItNow":{"type":"boolean"},"IsEmailAddressInvalid":{"type":"boolean"},"IsEmailAddressInUse":{"type":"boolean"}}},"KashFlow.Accounting.Model.SMTPConfigResponse":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"FromName":{"type":"string"},"FromEmail":{"type":"string"},"OverrideSMTPConfig":{"type":"boolean"},"AuthenticationType":{"format":"int32","description":" 0 = Basic,  1 = OAuth","enum":[0,1],"type":"integer"},"OAuthConfig":{"$ref":"#/definitions/KashFlow.Accounting.Model.SMTPConfigOAuthResponse"},"BasicConfig":{"$ref":"#/definitions/KashFlow.Accounting.Model.SMTPConfigBasicResponse"}}},"KashFlow.Accounting.Model.SMTPConfigOAuthResponse":{"type":"object","properties":{"ClientId":{"type":"string"},"SecretId":{"type":"string"},"TenantId":{"type":"string"},"AccessToken":{"type":"string"},"RefreshToken":{"type":"string"},"AccessTokenExpiryTime":{"format":"date-time","type":"string"},"IsRefreshTokenExpired":{"type":"boolean"}}},"KashFlow.Accounting.Model.SMTPConfigBasicResponse":{"type":"object","properties":{"ServerName":{"type":"string"},"PortNumber":{"format":"int32","type":"integer"},"UserName":{"type":"string"},"Password":{"type":"string"},"EncryptionType":{"format":"int32","description":" 0 = None,  1 = SSL,  2 = TLS","enum":[0,1,2],"type":"integer"}}},"KashFlow.Accounting.Model.SMTPConfigRequest":{"type":"object","properties":{"FromName":{"type":"string"},"FromEmail":{"type":"string"},"OverrideSMTPConfig":{"type":"boolean"},"AuthenticationType":{"format":"int32","description":" 0 = Basic,  1 = OAuth","enum":[0,1],"type":"integer"},"OAuthConfig":{"$ref":"#/definitions/KashFlow.Accounting.Model.SMTPConfigOAuth"},"BasicConfig":{"$ref":"#/definitions/KashFlow.Accounting.Model.SMTPConfigBasic"}}},"KashFlow.Accounting.Model.SMTPConfigOAuth":{"type":"object","properties":{"ClientId":{"type":"string"},"SecretId":{"type":"string"},"TenantId":{"type":"string"}}},"KashFlow.Accounting.Model.SMTPConfigBasic":{"type":"object","properties":{"ServerName":{"type":"string"},"PortNumber":{"format":"int32","type":"integer"},"UserName":{"type":"string"},"Password":{"type":"string"},"EncryptionType":{"type":"string"}}},"KashFlow.Accounting.Model.SMTPOAuthConfigRequest":{"type":"object","properties":{"OAuthConfig":{"$ref":"#/definitions/KashFlow.Accounting.Model.SMTPConfigOAuth"},"FromName":{"type":"string"},"FromEmail":{"type":"string"},"OverrideSMTPConfig":{"type":"boolean"}}},"KashFlow.Accounting.Model.Payment.Square.Location":{"type":"object","properties":{"Id":{"type":"string"},"Name":{"type":"string"},"Currency":{"type":"string"},"Timezone":{"type":"string"},"Status":{"format":"int32","description":" 0 = ACTIVE,  1 = INACTIVE","enum":[0,1],"type":"integer"},"business_name":{"type":"string"},"BusinessName":{"type":"string","readOnly":true},"merchant_id":{"type":"string"},"MerchantId":{"type":"string","readOnly":true}}},"KashFlow.Accounting.Model.InvoiceImporter.ImportProfile":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"RefreshToken":{"type":"string"},"LocationId":{"type":"string"},"MerchantId":{"type":"string"},"LocationName":{"type":"string"},"LocationCurrency":{"type":"string"},"EmailAddress":{"type":"string"},"LastSync":{"type":"string"}}},"KashFlow.Accounting.Model.InvoiceImporter.ImportSettings":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"EarliestDateToImport":{"format":"date-time","type":"string"},"BankAccountId":{"format":"int32","type":"integer"},"SquareClearingAccountId":{"format":"int32","type":"integer"},"CashClearingAccountId":{"format":"int32","type":"integer"},"OtherClearingAccountId":{"format":"int32","type":"integer"},"GiftCardClearingAccountId":{"format":"int32","type":"integer"},"SalesAccountId":{"format":"int32","type":"integer"},"RefundsAccountId":{"format":"int32","type":"integer"},"PaymentMethodId":{"format":"int32","type":"integer"},"TipsAccountId":{"format":"int32","type":"integer"},"SquareGiftCardAccountId":{"format":"int32","type":"integer"},"SquareGiftCardDiscountAccountId":{"format":"int32","type":"integer"},"AdvancedSettlementNominals":{"$ref":"#/definitions/KashFlow.Accounting.Model.InvoiceImporter.AdvancedSettlementNominals"}}},"KashFlow.Accounting.Model.InvoiceImporter.AdvancedSettlementNominals":{"type":"object","properties":{"FeesAccountId":{"format":"int32","type":"integer"},"AdjustmentAccountId":{"format":"int32","type":"integer"},"BalanceChargeAccountId":{"format":"int32","type":"integer"},"FreeProcessingAccountId":{"format":"int32","type":"integer"},"HoldAdjustmentAccountId":{"format":"int32","type":"integer"},"RedemptionCodeAccountId":{"format":"int32","type":"integer"},"ReturnedPayoutAccountId":{"format":"int32","type":"integer"},"OtherAccountId":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.Paging[KashFlow.Accounting.Model.InvoiceImporter.ImportRun]":{"required":["Data"],"type":"object","properties":{"MetaData":{"$ref":"#/definitions/KashFlow.Accounting.Model.PagingMetadata"},"Data":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.InvoiceImporter.ImportRun"}}}},"KashFlow.Accounting.Model.InvoiceImporter.ImportRun":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"ProfileId":{"format":"int32","type":"integer"},"StartDate":{"format":"date-time","type":"string"},"EndDate":{"format":"date-time","type":"string"},"TimezoneName":{"type":"string"},"Status":{"format":"int32","description":" 0 = Unknown,  1 = Pending,  2 = InProgress,  3 = Synced,  4 = Failed","enum":[0,1,2,3,4],"type":"integer"},"NumberOfPayments":{"format":"int32","type":"integer"},"NumberOfRefunds":{"format":"int32","type":"integer"},"InvoiceNumber":{"format":"int32","type":"integer"},"Message":{"type":"string"},"ExecutionDate":{"format":"date-time","type":"string"}}},"KashFlow.Accounting.Model.CustomerSquareSync":{"type":"object","properties":{"Id":{"type":"string"},"Code":{"type":"string"},"Name":{"type":"string"},"Mail":{"type":"string"},"Phone":{"type":"string"},"Company":{"type":"string"},"Synced":{"type":"boolean"}}},"KashFlow.Accounting.Model.CustomerSync":{"type":"object","properties":{"Id":{"type":"string"},"Code":{"type":"string"},"Synced":{"type":"boolean"}}},"KashFlow.Accounting.Model.InvoiceImporter.ImportSettlement":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"ExternalId":{"type":"string"},"ProfileId":{"format":"int32","type":"integer"},"InitiatedAt":{"format":"date-time","type":"string"},"Charge":{"format":"double","type":"number"},"BankAccountId":{"format":"int32","type":"integer"},"ExecutionDate":{"format":"date-time","type":"string"},"TimezoneName":{"type":"string"}}},"KashFlow.Accounting.Model.StockOptions":{"type":"object","properties":{"EnableStockManagement":{"type":"boolean"},"EnableWholesalePricing":{"type":"boolean"},"ECSalesProducts":{"type":"boolean"}}},"KashFlow.Accounting.Model.UserSubscription.Package":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Name":{"type":"string"},"Description":{"type":"string"},"Price":{"format":"double","type":"number"},"IsPromoCodeSupported":{"type":"boolean"},"ApplicationId":{"format":"int32","description":" 1 = RsrApp,  2 = OldWebApp,  3 = MobileIOS,  4 = MobileAndroid,  5 = KFConnect,  6 = IrisElementBookkeepingIOS,  7 = IrisElementBookkeepingAndroid","enum":[1,2,3,4,5,6,7],"type":"integer"},"IsActive":{"type":"boolean"},"HasMultiUserAccessSupported":{"type":"boolean"},"RefereeDiscountAmount":{"format":"double","type":"number"},"IsRestricted":{"type":"boolean"},"ReferrerDiscountPercentage":{"format":"double","type":"number"},"PackageDisplaySuffix":{"type":"string"},"RefereeDiscountBillingDurationInMonths":{"format":"int32","type":"integer"},"SupportsAffiliates":{"type":"boolean"},"DurationInMonths":{"format":"int32","type":"integer"},"VatAmount":{"format":"double","type":"number"},"PackageValue":{"format":"int32","type":"integer"},"IsMobileAppPromotion":{"type":"boolean"}}},"KashFlow.Accounting.Model.UserSubscription.CancelSubscription":{"type":"object","properties":{"ReasonId":{"format":"int32","type":"integer"},"OtherText":{"type":"string"},"ExtraInfo":{"type":"string"},"SimilarProductId":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.UserSubscription.CancelReasons":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Description":{"type":"string"}}},"KashFlow.Accounting.Model.UserSubscription.CompetetiveProduct":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Name":{"type":"string"}}},"KashFlow.Accounting.Model.SupplierStatistics":{"type":"object","properties":{"FirstTransactionDate":{"type":"string"},"LastTransactionDate":{"type":"string"},"TotalBilled":{"type":"string"},"TotalPaid":{"type":"string"},"TotalDue":{"type":"string"}}},"KashFlow.Accounting.Model.SuppliersStatistics":{"type":"object","properties":{"TotalBilled":{"type":"string"},"TotalPaid":{"type":"string"},"TotalDue":{"type":"string"}}},"KashFlow.Accounting.Model.Suppliers.SupplierFilterParameters":{"type":"object","properties":{"Page":{"format":"int32","type":"integer"},"PerPage":{"format":"int32","type":"integer"},"Order":{"type":"string"},"SortBy":{"format":"int32","description":" 0 = Name,  1 = Code,  2 = TotalPaidAmount,  3 = OutstandingBalance","enum":[0,1,2,3],"type":"integer"},"Namestartswith":{"type":"string"},"Filterarchived":{"type":"boolean"},"SearchText":{"type":"string"},"StartCreationDate":{"type":"string"},"EndCreationDate":{"type":"string"},"SkipPerPageValidation":{"type":"boolean"}}},"KashFlow.Accounting.Model.Paging[KashFlow.Accounting.DTO.Supplier.SupplierListResponse]":{"required":["Data"],"type":"object","properties":{"MetaData":{"$ref":"#/definitions/KashFlow.Accounting.Model.PagingMetadata"},"Data":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Supplier.SupplierListResponse"}}}},"KashFlow.Accounting.DTO.Supplier.SupplierListResponse":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Code":{"type":"string"},"Name":{"type":"string"},"UsesDefaultPdftTheme":{"type":"boolean"},"Currency":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Response.CurrencyResponse"},"TotalPaidAmount":{"format":"double","type":"number"},"OutstandingBalance":{"format":"double","type":"number"},"DoesSupplierHasTransactionsInVATReturn":{"type":"boolean"},"SourceName":{"type":"string"},"Address":{"$ref":"#/definitions/KashFlow.Core.Model.Address"},"Contacts":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Contact"}},"TradeBorderType":{"type":"string"},"IsArchived":{"type":"boolean"},"IsCISReverseCharge":{"type":"boolean"},"ApplyWithholdingTax":{"type":"boolean"},"WithholdingTaxReferences":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.CustomField"}},"IsVatRateEnabled":{"type":"boolean"},"DefaultVatRate":{"format":"double","type":"number"},"VatExempt":{"type":"boolean"}}},"KashFlow.Accounting.DTO.Supplier.SupplierRequest":{"type":"object","properties":{"Code":{"type":"string"},"Name":{"type":"string"},"Address":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Request.AddressRequest"},"DefaultPdfTheme":{"format":"int32","type":"integer"},"BankAccount":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Supplier.SupplierBankAccountInfo"},"VatNumber":{"type":"string"},"PaymentMethod":{"format":"int32","type":"integer"},"DefaultNominalCode":{"format":"int32","type":"integer"},"PaymentTerms":{"$ref":"#/definitions/KashFlow.Accounting.DTO.PaymentTerms"},"Currency":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Request.CurrencyRequest"},"WithholdingTaxRate":{"format":"double","type":"number"},"UniqueEntityNumber":{"type":"string"},"Note":{"type":"string"},"CreateSupplierCodeIfDuplicate":{"type":"boolean"},"CreateSupplierNameIfEmptyOrNull":{"type":"boolean"},"Contacts":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Contact"}},"TradeBorderType":{"type":"string"},"IsArchived":{"type":"boolean"},"IsCISReverseCharge":{"type":"boolean"},"ApplyWithholdingTax":{"type":"boolean"},"WithholdingTaxReferences":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.CustomField"}},"IsVatRateEnabled":{"type":"boolean"},"DefaultVatRate":{"format":"double","type":"number"},"VatExempt":{"type":"boolean"}}},"KashFlow.Accounting.DTO.Supplier.SupplierBankAccountInfo":{"type":"object","properties":{"Name":{"type":"string"},"Number":{"type":"string"},"SortCode":{"type":"string"}}},"KashFlow.Accounting.DTO.Supplier.SupplierResponse":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Code":{"type":"string"},"Name":{"type":"string"},"Address":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Response.AddressResponse"},"DefaultPdfTheme":{"format":"int32","type":"integer"},"BankAccount":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Supplier.SupplierBankAccountInfo"},"VatNumber":{"type":"string"},"PaymentMethod":{"format":"int32","type":"integer"},"DefaultNominalCode":{"format":"int32","type":"integer"},"PaymentTerms":{"$ref":"#/definitions/KashFlow.Accounting.DTO.PaymentTerms"},"WithholdingTaxRate":{"format":"double","type":"number"},"BilledNetAmount":{"format":"double","type":"number"},"BilledVatAmount":{"format":"double","type":"number"},"UniqueEntityNumber":{"type":"string"},"Note":{"type":"string"},"CreatedDate":{"type":"string"},"LastUpdatedDate":{"type":"string"},"UsesDefaultPdftTheme":{"type":"boolean"},"Currency":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Response.CurrencyResponse"},"TotalPaidAmount":{"format":"double","type":"number"},"OutstandingBalance":{"format":"double","type":"number"},"DoesSupplierHasTransactionsInVATReturn":{"type":"boolean"},"SourceName":{"type":"string"},"Contacts":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Contact"}},"TradeBorderType":{"type":"string"},"IsArchived":{"type":"boolean"},"IsCISReverseCharge":{"type":"boolean"},"ApplyWithholdingTax":{"type":"boolean"},"WithholdingTaxReferences":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.CustomField"}},"IsVatRateEnabled":{"type":"boolean"},"DefaultVatRate":{"format":"double","type":"number"},"VatExempt":{"type":"boolean"}}},"KashFlow.Accounting.Model.SupplierMassDeleteStatus":{"type":"object","properties":{"Code":{"type":"string"},"SupplierCanBeDelete":{"type":"boolean"},"Reason":{"type":"string"}}},"KashFlow.Accounting.Model.SupplierBulkInvoiceDetails":{"type":"object","properties":{"SupplierCode":{"type":"string"},"SupplierName":{"type":"string"},"NetAmount":{"format":"double","type":"number"},"VATAmount":{"format":"double","type":"number"},"PaidAmount":{"format":"double","type":"number"},"InvoicesCount":{"format":"int32","type":"integer"},"LastInvoiceDate":{"format":"int64","type":"integer"}}},"KashFlow.Accounting.RestApi.Parameters.SupplierTransactionFilterParameters":{"type":"object","properties":{"Page":{"format":"int32","description":"The page number","type":"integer"},"PerPage":{"format":"int32","description":"The number of items per page.","type":"integer"},"SortBy":{"format":"int32","description":"The Property to sort by 0 = Number,  1 = Date,  2 = Project,  3 = Amount,  4 = Status,  5 = Reference,  6 = Type","enum":[0,1,2,3,4,5,6],"type":"integer"},"Order":{"description":"Sorting order (asc or desc) (default is asc)","type":"string"},"typeFilterBy":{"format":"int32","description":"The transaction filter by 0 = AllTypes,  2 = Payment,  4 = Purchase,  5 = Expense,  6 = CreditNote,  7 = PurchaseOrder","enum":[0,2,4,5,6,7],"type":"integer"},"projectFilterBy":{"format":"int32","description":"The project to filter by.","type":"integer"},"statusFilterBy":{"description":"The status to filter by.","type":"string"}}},"KashFlow.Accounting.Model.Paging[KashFlow.Accounting.Model.SupplierTransaction]":{"required":["Data"],"type":"object","properties":{"MetaData":{"$ref":"#/definitions/KashFlow.Accounting.Model.PagingMetadata"},"Data":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.SupplierTransaction"}}}},"KashFlow.Accounting.Model.SupplierTransaction":{"type":"object","properties":{"NumberOfAttachments":{"format":"int32","type":"integer"},"Type":{"format":"int32","description":" 0 = AllTypes,  2 = Payment,  4 = Purchase,  5 = Expense,  6 = CreditNote,  7 = PurchaseOrder","enum":[0,2,4,5,6,7],"type":"integer"},"StatusNumber":{"format":"int32","type":"integer"},"Status":{"type":"string"},"IsExpense":{"type":"boolean"},"Id":{"format":"int64","type":"integer"},"Number":{"format":"int64","type":"integer"},"ParentNumber":{"format":"int64","type":"integer"},"Date":{"type":"string"},"Project":{"type":"string"},"Amount":{"format":"double","type":"number"},"Permalink":{"type":"string"},"Reference":{"type":"string"}}},"KashFlow.Accounting.Model.TransactionParameters":{"type":"object","properties":{"SupplierCode":{"type":"string"},"StartDate":{"format":"date-time","type":"string"},"EndDate":{"format":"date-time","type":"string"},"ExcludePaidInvoices":{"format":"int32","type":"integer"},"ExcludeOpeningBalance":{"format":"int32","type":"integer"},"FilterBy":{"type":"string"}}},"KashFlow.Accounting.Model.Reports.TrialBalanceReport.TrialBalanceReport":{"required":["StartDate","EndDate","ExcludeZeroBalance","TotalDebit","TotalCredit"],"type":"object","properties":{"Balances":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.TrialBalanceReport.Balance"}},"StartDate":{"type":"string"},"EndDate":{"type":"string"},"ExcludeZeroBalance":{"type":"boolean"},"TotalDebit":{"format":"double","type":"number","readOnly":true},"TotalCredit":{"format":"double","type":"number","readOnly":true}}},"KashFlow.Accounting.Model.Reports.TrialBalanceReport.Balance":{"required":["Id","Code","Name","Type","Debit","Credit"],"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Code":{"format":"int32","type":"integer"},"Name":{"type":"string"},"Type":{"format":"int32","description":" 0 = Nominal,  1 = BankAccount,  2 = Debtors,  3 = Creditors,  4 = InputVat,  5 = OutputVat","enum":[0,1,2,3,4,5],"type":"integer"},"Debit":{"format":"double","type":"number"},"Credit":{"format":"double","type":"number"},"BankAccountId":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.DTO.Trip.TripCostRequestParameters":{"required":["Date","VehicleTypeId","Distance"],"type":"object","properties":{"Date":{"format":"date-time","type":"string"},"VehicleTypeId":{"format":"byte","type":"string"},"Distance":{"format":"double","type":"number"},"EngineSizeId":{"format":"int32","type":"integer"},"EngineTypeId":{"format":"int32","type":"integer"},"Passenger":{"format":"int32","type":"integer"},"Action":{"format":"int32","description":" 0 = TripCost,  1 = AdvisoryTripCost","enum":[0,1],"type":"integer"},"ClaimVAT":{"type":"boolean"},"IsEditTrip":{"type":"boolean"},"TripNumber":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.DTO.Trip.TripResponse":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"CostOfFuel":{"format":"double","type":"number"},"Vat":{"format":"double","type":"number"},"VehicleType":{"type":"string"},"VATReturnId":{"format":"int64","type":"integer"},"Value":{"format":"double","type":"number"},"AdvisoryFuelRate":{"format":"double","type":"number"},"DisableDisallowed":{"type":"boolean"},"Number":{"format":"int32","type":"integer"},"VatExempt":{"type":"boolean"},"Distance":{"format":"double","type":"number"},"VehicleTypeId":{"format":"byte","type":"string"},"EngineTypeId":{"format":"int32","type":"integer"},"EngineSizeId":{"format":"int32","type":"integer"},"Date":{"format":"date-time","type":"string"},"ClaimVAT":{"type":"boolean"},"Purpose":{"type":"string"},"StartAddress":{"type":"string"},"EndAddress":{"type":"string"},"Route":{"type":"string"},"IsRoundTrip":{"type":"boolean"},"Disallowed":{"type":"boolean"},"Passenger":{"format":"int32","type":"integer"},"EmployeeId":{"format":"int32","type":"integer"},"EmployeeName":{"type":"string"}}},"KashFlow.Accounting.DTO.Base.TripBase":{"type":"object","properties":{"Number":{"format":"int32","type":"integer"},"VatExempt":{"type":"boolean"},"Distance":{"format":"double","type":"number"},"VehicleTypeId":{"format":"byte","type":"string"},"EngineTypeId":{"format":"int32","type":"integer"},"EngineSizeId":{"format":"int32","type":"integer"},"Date":{"format":"date-time","type":"string"},"ClaimVAT":{"type":"boolean"},"Purpose":{"type":"string"},"StartAddress":{"type":"string"},"EndAddress":{"type":"string"},"Route":{"type":"string"},"IsRoundTrip":{"type":"boolean"},"Disallowed":{"type":"boolean"},"Passenger":{"format":"int32","type":"integer"},"EmployeeId":{"format":"int32","type":"integer"},"EmployeeName":{"type":"string"}}},"KashFlow.Accounting.RestApi.Parameters.TripFilterParameters":{"type":"object","properties":{"Page":{"format":"int32","description":"Page number. (default is 1)","type":"integer"},"PerPage":{"format":"int32","description":"PerPage is number of records per page. (default is 10)","type":"integer"},"Order":{"description":"Sorting order (asc or desc) (default is asc)","type":"string"},"SortColumn":{"format":"int32","description":"Sort By column. (default is 0 i.e.,Date) 0 = Date,  1 = VehicleType,  2 = Purpose,  3 = StartAddress,  4 = EndAddress,  5 = Distance,  6 = Value,  7 = Num,  8 = EmployeeName","enum":[0,1,2,3,4,5,6,7,8],"type":"integer"},"VehicleType":{"format":"int32","description":"Type of vehicle. (default is 0 i.e. All) 0 = All,  1 = CarOrVan,  2 = Motorcycle,  3 = ElectricCar","enum":[0,1,2,3],"type":"integer"},"EmployeeId":{"format":"int32","description":"Employee Id. (default is All, 0 = Company User)","type":"integer"},"SearchText":{"description":"Search Trips by character with the provided string","type":"string"}}},"KashFlow.Accounting.Model.Paging[KashFlow.Accounting.DTO.Trip.TripResponse,KashFlow.Accounting.Model.MileagePagingMetadata]":{"required":["Data"],"type":"object","properties":{"MetaData":{"$ref":"#/definitions/KashFlow.Accounting.Model.MileagePagingMetadata"},"Data":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Trip.TripResponse"}}}},"KashFlow.Accounting.Model.MileagePagingMetadata":{"type":"object","properties":{"TotalMiles":{"format":"double","type":"number"},"TotalCarMiles":{"format":"double","type":"number"},"TotalValue":{"format":"double","type":"number"},"AdvisoryFuelRateCutOffDate":{"format":"int32","type":"integer"},"TotalRecords":{"format":"int32","type":"integer"},"FirstPageUrl":{"type":"string"},"LastPageUrl":{"type":"string"},"PreviousPageUrl":{"type":"string"},"NextPageUrl":{"type":"string"},"TotalAmount":{"format":"double","type":"number"},"InvoiceLimitReached":{"type":"boolean"}}},"KashFlow.Accounting.Model.User":{"type":"object","properties":{"Number":{"format":"int32","type":"integer"},"FullName":{"type":"string"},"RoleId":{"format":"int32","type":"integer"},"Email":{"type":"string"},"Username":{"type":"string"},"RoleName":{"type":"string"},"Password":{"type":"string"},"MemorableWord":{"type":"string"},"UserAccountDisabled":{"type":"boolean"},"IsLockedOut":{"type":"boolean"},"Status":{"format":"int32","description":" 1 = None,  2 = Active,  3 = Pending,  4 = Disabled","enum":[1,2,3,4],"type":"integer"},"StatusCode":{"type":"string","readOnly":true},"FailedLoginAttemptsCount":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.UserCredential":{"type":"object","properties":{"Password":{"type":"string"},"MemorableWord":{"type":"string"},"NewPassword":{"type":"string"},"ConfirmPassword":{"type":"string"},"ConfirmMemorableWord":{"type":"string"}}},"KashFlow.Accounting.Model.VAT.AggregatedVatLiability":{"type":"object","properties":{"AmountOutstanding":{"format":"double","type":"number"},"AmountRepayable":{"format":"double","type":"number"},"DisplayStartDate":{"format":"date-time","type":"string"},"From":{"format":"date-time","type":"string"},"To":{"format":"date-time","type":"string"}}},"KashFlow.Accounting.DTO.VatMossReturn.VatMossReturnListResponse":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Downloaded":{"type":"boolean"},"JournalId":{"format":"int32","type":"integer"},"Key":{"type":"string"},"Errors":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.VatMossReturn.ErrorResponse"}},"CreatedDate":{"type":"string"},"Period":{"type":"string"},"StartDate":{"type":"string"},"EndDate":{"type":"string"},"VatScheme":{"format":"int32","description":" 0 = Accrual,  1 = Cash","enum":[0,1],"type":"integer"},"ReturnType":{"format":"int32","description":" 0 = NonUnion,  1 = Union","enum":[0,1],"type":"integer"},"HasFixedEstablishment":{"type":"boolean"},"VatNumber":{"type":"string"},"TaxableSupplies":{"type":"boolean"},"NetValueOfSales":{"format":"double","type":"number"},"NetVatDue":{"format":"double","type":"number"}}},"KashFlow.Accounting.DTO.Base.VatMossReturnBase":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Base.VatMossReturnItemResponse"}},"CreatedDate":{"type":"string"},"Period":{"type":"string"},"StartDate":{"type":"string"},"EndDate":{"type":"string"},"VatScheme":{"format":"int32","description":" 0 = Accrual,  1 = Cash","enum":[0,1],"type":"integer"},"ReturnType":{"format":"int32","description":" 0 = NonUnion,  1 = Union","enum":[0,1],"type":"integer"},"HasFixedEstablishment":{"type":"boolean"},"VatNumber":{"type":"string"},"TaxableSupplies":{"type":"boolean"},"NetValueOfSales":{"format":"double","type":"number"},"NetVatDue":{"format":"double","type":"number"}}},"KashFlow.Accounting.DTO.Base.VatMossReturnItemResponse":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"CountryName":{"type":"string"},"CountryCode":{"type":"string"},"VatType":{"format":"int32","description":" 1 = Standard,  2 = Parking,  3 = Reduced,  4 = SuperReduced","enum":[1,2,3,4],"type":"integer"},"VatRate":{"format":"double","type":"number"},"VatAmount":{"format":"double","type":"number"},"NetValueOfSupplies":{"format":"double","type":"number"}}},"KashFlow.Accounting.DTO.VatMossReturn.VatMossReturnResponse":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Downloaded":{"type":"boolean"},"JournalId":{"format":"int32","type":"integer"},"Key":{"type":"string"},"Errors":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.VatMossReturn.ErrorResponse"}},"JournalNumber":{"format":"int32","type":"integer"},"Items":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.DTO.Base.VatMossReturnItemResponse"}},"CreatedDate":{"type":"string"},"Period":{"type":"string"},"StartDate":{"type":"string"},"EndDate":{"type":"string"},"VatScheme":{"format":"int32","description":" 0 = Accrual,  1 = Cash","enum":[0,1],"type":"integer"},"ReturnType":{"format":"int32","description":" 0 = NonUnion,  1 = Union","enum":[0,1],"type":"integer"},"HasFixedEstablishment":{"type":"boolean"},"VatNumber":{"type":"string"},"TaxableSupplies":{"type":"boolean"},"NetValueOfSales":{"format":"double","type":"number"},"NetVatDue":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.Reports.VatMossDrillDown":{"type":"object","properties":{"StartDate":{"type":"string"},"EndDate":{"type":"string"},"DrilledDownItems":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.VatMossDrillDownItem"}}}},"KashFlow.Accounting.Model.Reports.VatMossDrillDownItem":{"type":"object","properties":{"InvoiceNumber":{"format":"int32","type":"integer"},"CustomerCode":{"type":"string"},"CustomerName":{"type":"string"},"CountryCode":{"type":"string"},"CountryName":{"type":"string"},"VATRate":{"format":"double","type":"number"},"VATAmount":{"format":"double","type":"number"},"CustomerReference":{"type":"string"},"NetValueOfSupplies":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.Reports.VatReports.VatExemptZeroRatedReport":{"required":["StartDate","EndDate","InvoiceLineTotal","PurchaseLineTotal"],"type":"object","properties":{"StartDate":{"format":"date-time","type":"string"},"EndDate":{"format":"date-time","type":"string"},"InvoiceLines":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.VatReports.VatExemptZeroRatedReportItem"}},"InvoiceLineTotal":{"format":"double","type":"number","readOnly":true},"PurchaseLines":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.VatReports.VatExemptZeroRatedReportItem"}},"PurchaseLineTotal":{"format":"double","type":"number","readOnly":true},"BankLines":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.VatReports.VatExemptZeroRatedReportItem"}},"BankLineTotal":{"format":"double","type":"number","readOnly":true}}},"KashFlow.Accounting.Model.Reports.VatReports.VatExemptZeroRatedReportItem":{"required":["Date","Name","Number","Total","VatRate","NominalName","NominalCode","IsCustomer"],"type":"object","properties":{"Date":{"format":"date-time","type":"string"},"Name":{"type":"string"},"Number":{"format":"int32","type":"integer"},"Description":{"type":"string"},"Total":{"format":"double","type":"number"},"VatRate":{"type":"string"},"NominalName":{"type":"string"},"NominalCode":{"format":"int32","type":"integer"},"IsCustomer":{"type":"boolean"}}},"KashFlow.Accounting.Model.Reports.VatReports.SalesReportRequest":{"required":["StartDate","EndDate"],"type":"object","properties":{"ReportType":{"format":"int32","description":" 1 = EC,  2 = NonEC","enum":[1,2],"type":"integer"},"BringForwardOlderUnReconciledItems":{"type":"boolean"},"StartDate":{"type":"string"},"EndDate":{"type":"string"}}},"KashFlow.Accounting.Model.Reports.VatReports.SalesReportResponse":{"type":"object","properties":{"MetaData":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.ReportMetaData"},"ReportData":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.VatReports.SalesResponse"}}}},"KashFlow.Accounting.Model.Reports.ReportMetaData":{"type":"object","properties":{"Title":{"type":"string"}}},"KashFlow.Accounting.Model.Reports.VatReports.SalesResponse":{"type":"object","properties":{"CustomerCode":{"type":"string"},"VatNumber":{"type":"string"},"TotalValueOfSupplies":{"format":"double","type":"number"},"SubsidiaryIdentifier":{"type":"string"},"DeclYear":{"type":"string"},"DeclEndMonth":{"format":"int32","type":"integer"},"CurrencyCode":{"type":"string"},"ContactName":{"type":"string"},"CountryCode":{"type":"string"},"Transindicator":{"format":"int32","type":"integer"},"Indicator":{"type":"string"},"VatRegNo":{"type":"string"},"CompanyName":{"type":"string"}}},"KashFlow.Accounting.Model.Reports.VatReports.VatTradingDetails":{"type":"object","properties":{"VatRate":{"type":"string"},"VatTrading":{"$ref":"#/definitions/KashFlow.Accounting.Model.Reports.VatReports.VatTrading"}}},"KashFlow.Accounting.Model.Reports.VatReports.VatTrading":{"type":"object","properties":{"DomesticSales":{"format":"double","type":"number"},"EUSales":{"format":"double","type":"number"},"ROWSales":{"format":"double","type":"number"},"NIEUSales":{"format":"double","type":"number"},"NetSales":{"format":"double","type":"number"},"EUPurchases":{"format":"double","type":"number"},"ResalesPurchases":{"format":"double","type":"number"},"NonResalesPurchases":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.VAT.VatReturnWithBoxValues":{"required":["Box1","Box2","Box3","Box4","Box5","Box6","Box7","Box8","Box9","Id","StartDate","EndDate","DueDate","PeriodId","Status","AreVatNumbersValid","IsCashAccounting","IsFRS","HasCSV","TransactionsCount","VatReturnBatchItemId","RegisteredIn"],"type":"object","properties":{"Box1":{"format":"double","type":"number"},"Box2":{"format":"double","type":"number"},"Box3":{"format":"double","type":"number"},"Box4":{"format":"double","type":"number"},"Box5":{"format":"double","type":"number"},"Box6":{"format":"double","type":"number"},"Box7":{"format":"double","type":"number"},"Box8":{"format":"double","type":"number"},"Box9":{"format":"double","type":"number"},"Id":{"format":"int64","type":"integer"},"StartDate":{"format":"date-time","type":"string"},"EndDate":{"format":"date-time","type":"string"},"DueDate":{"format":"date-time","type":"string"},"PeriodId":{"type":"string"},"Status":{"format":"int32","description":" 0 = Open,  1 = Pending,  2 = MarkedAsSubmitted,  3 = SubmittedToHMRC,  4 = Failed","enum":["Open","Pending","Marked as Submitted","Submitted to HMRC","Failed"],"type":"integer"},"SubmissionErrorMessage":{"type":"string"},"ECSLStatus":{"format":"int32","description":" 0 = Blank,  1 = Open,  2 = Pending,  3 = NotRequired,  4 = SubmittedToHmrc,  5 = Failed,  6 = Disabled,  7 = MarkedAsSubmitted","enum":["","Open","Pending","Not Required","Submitted to HMRC","Failed","Disabled","Marked as Submitted"],"type":"integer"},"FileDate":{"format":"date-time","type":"string"},"ECSLSubmissionErrorMessage":{"type":"string"},"PaidStatus":{"format":"int32","description":" 0 = Paid,  1 = Unpaid,  2 = NA","enum":["Paid","Unpaid","-"],"type":"integer"},"SubmissionResponseTimeStamp":{"format":"date-time","type":"string"},"ECSLSubmissionResponseTimeStamp":{"format":"date-time","type":"string"},"IsSourceMTD":{"type":"boolean"},"AreVatNumbersValid":{"type":"boolean"},"IsCashAccounting":{"type":"boolean"},"IsFRS":{"type":"boolean"},"FRSRate":{"format":"double","type":"number"},"HasCSV":{"type":"boolean"},"TransactionsCount":{"format":"int64","type":"integer"},"SubmittedBy":{"format":"int32","type":"integer"},"VatReturnBatchItemId":{"format":"int64","type":"integer"},"RegisteredIn":{"type":"string"},"PVABoxTextChangeFrom":{"format":"date-time","type":"string"}}},"KashFlow.Accounting.DTO.VatReturn.VatReturnRequest":{"type":"object","properties":{"Box8":{"format":"double","type":"number"},"Id":{"format":"int64","type":"integer"},"StartDate":{"format":"date-time","type":"string"},"EndDate":{"format":"date-time","type":"string"},"DueDate":{"format":"date-time","type":"string"},"PeriodId":{"type":"string"},"Status":{"format":"int32","description":" 0 = Open,  1 = Pending,  2 = MarkedAsSubmitted,  3 = SubmittedToHMRC,  4 = Failed","enum":["Open","Pending","Marked as Submitted","Submitted to HMRC","Failed"],"type":"integer"},"ECSLStatus":{"format":"int32","description":" 0 = Blank,  1 = Open,  2 = Pending,  3 = NotRequired,  4 = SubmittedToHmrc,  5 = Failed,  6 = Disabled,  7 = MarkedAsSubmitted","enum":["","Open","Pending","Not Required","Submitted to HMRC","Failed","Disabled","Marked as Submitted"],"type":"integer"}}},"KashFlow.Accounting.Model.VAT.VatReturns":{"type":"object","properties":{"Data":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.VAT.VatReturn"}},"Metadata":{"$ref":"#/definitions/KashFlow.Accounting.Model.VAT.VatReturnsMetadata"},"VatError":{"$ref":"#/definitions/KashFlow.Accounting.Model.VAT.ErrorDetail"}}},"KashFlow.Accounting.Model.VAT.VatReturn":{"required":["Id","StartDate","EndDate","DueDate","PeriodId","Status","AreVatNumbersValid","IsCashAccounting","IsFRS","HasCSV","TransactionsCount","VatReturnBatchItemId","RegisteredIn"],"type":"object","properties":{"Id":{"format":"int64","type":"integer"},"StartDate":{"format":"date-time","type":"string"},"EndDate":{"format":"date-time","type":"string"},"DueDate":{"format":"date-time","type":"string"},"PeriodId":{"type":"string"},"Status":{"format":"int32","description":" 0 = Open,  1 = Pending,  2 = MarkedAsSubmitted,  3 = SubmittedToHMRC,  4 = Failed","enum":["Open","Pending","Marked as Submitted","Submitted to HMRC","Failed"],"type":"integer"},"SubmissionErrorMessage":{"type":"string"},"ECSLStatus":{"format":"int32","description":" 0 = Blank,  1 = Open,  2 = Pending,  3 = NotRequired,  4 = SubmittedToHmrc,  5 = Failed,  6 = Disabled,  7 = MarkedAsSubmitted","enum":["","Open","Pending","Not Required","Submitted to HMRC","Failed","Disabled","Marked as Submitted"],"type":"integer"},"FileDate":{"format":"date-time","type":"string"},"ECSLSubmissionErrorMessage":{"type":"string"},"PaidStatus":{"format":"int32","description":" 0 = Paid,  1 = Unpaid,  2 = NA","enum":["Paid","Unpaid","-"],"type":"integer"},"SubmissionResponseTimeStamp":{"format":"date-time","type":"string"},"ECSLSubmissionResponseTimeStamp":{"format":"date-time","type":"string"},"IsSourceMTD":{"type":"boolean"},"AreVatNumbersValid":{"type":"boolean"},"IsCashAccounting":{"type":"boolean"},"IsFRS":{"type":"boolean"},"FRSRate":{"format":"double","type":"number"},"HasCSV":{"type":"boolean"},"TransactionsCount":{"format":"int64","type":"integer"},"SubmittedBy":{"format":"int32","type":"integer"},"VatReturnBatchItemId":{"format":"int64","type":"integer"},"RegisteredIn":{"type":"string"},"PVABoxTextChangeFrom":{"format":"date-time","type":"string"}}},"KashFlow.Accounting.Model.VAT.VatReturnsMetadata":{"type":"object","properties":{"LatestVatReturn":{"$ref":"#/definitions/KashFlow.Accounting.Model.VAT.VatReturnMetadata"},"OldestOpenVatReturn":{"$ref":"#/definitions/KashFlow.Accounting.Model.VAT.VatReturnMetadata"},"HasMultipleVatReturns":{"type":"boolean"}}},"KashFlow.Accounting.Model.VAT.VatReturnMetadata":{"type":"object","properties":{"EndDate":{"format":"date-time","type":"string"},"Id":{"format":"int64","type":"integer"},"SubmissionStatus":{"format":"int32","description":" 0 = Open,  1 = Pending,  2 = MarkedAsSubmitted,  3 = SubmittedToHMRC,  4 = Failed","enum":["Open","Pending","Marked as Submitted","Submitted to HMRC","Failed"],"type":"integer"},"PeriodKey":{"type":"string"}}},"KashFlow.Accounting.Model.VAT.VatReturnsQuery":{"type":"object","properties":{"Year":{"format":"int32","type":"integer"},"Status":{"format":"int32","description":" 0 = All,  1 = Open,  2 = Submitted,  3 = SubmittedToHMRC,  4 = MarkedAsSubmitted,  5 = Failed,  6 = Pending","enum":["all","open","submitted","submittedtohmrc","markedassubmitted","failed","pending"],"type":"integer"},"Order":{"format":"int32","description":" 0 = Asc,  1 = Desc","enum":[0,1],"type":"integer"},"Page":{"format":"int32","type":"integer"},"PageSize":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.DTO.Base.VatReturnBase":{"type":"object","properties":{"StartDate":{"format":"date-time","type":"string"},"EndDate":{"format":"date-time","type":"string"}}},"KashFlow.Accounting.Model.VAT.VATReturnBreakdown":{"type":"object","properties":{"Box1":{"$ref":"#/definitions/KashFlow.Accounting.Model.VAT.BoxDetails"},"Box2":{"$ref":"#/definitions/KashFlow.Accounting.Model.VAT.BoxDetails"},"Box3":{"$ref":"#/definitions/KashFlow.Accounting.Model.VAT.BoxDetails"},"Box4":{"$ref":"#/definitions/KashFlow.Accounting.Model.VAT.BoxDetails"},"Box5":{"$ref":"#/definitions/KashFlow.Accounting.Model.VAT.BoxDetails"},"Box6":{"$ref":"#/definitions/KashFlow.Accounting.Model.VAT.BoxDetails"},"Box7":{"$ref":"#/definitions/KashFlow.Accounting.Model.VAT.BoxDetails"},"Box8":{"$ref":"#/definitions/KashFlow.Accounting.Model.VAT.BoxDetails"},"Box9":{"$ref":"#/definitions/KashFlow.Accounting.Model.VAT.BoxDetails"},"Metadata":{"$ref":"#/definitions/KashFlow.Accounting.Model.VAT.VATReturnBreakdownMetadata"}}},"KashFlow.Accounting.Model.VAT.BoxDetails":{"required":["List","Value"],"type":"object","properties":{"List":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.VAT.Entity"}},"Value":{"format":"double","type":"number"}}},"KashFlow.Accounting.Model.VAT.VATReturnBreakdownMetadata":{"required":["StartDate","EndDate"],"type":"object","properties":{"StartDate":{"format":"date-time","type":"string"},"EndDate":{"format":"date-time","type":"string"},"IsFRS":{"type":"boolean"}}},"KashFlow.Accounting.Model.VAT.Entity":{"required":["Date","Number","Code","Name","NetAmount","VATAmount","VATLevel","IsVatExempt","IsBadDebt","Type","Id"],"type":"object","properties":{"Date":{"format":"date-time","type":"string"},"Number":{"format":"int64","type":"integer"},"Code":{"type":"string"},"Name":{"type":"string"},"Reference":{"type":"string"},"NetAmount":{"format":"double","type":"number"},"VATAmount":{"format":"double","type":"number"},"VATLevel":{"format":"double","type":"number"},"IsVatExempt":{"type":"boolean"},"IsBadDebt":{"type":"boolean"},"Type":{"format":"int32","description":" 0 = Invoice,  1 = Purchase,  2 = Bank,  3 = Journal,  4 = Mileage,  5 = Expense","enum":[0,1,2,3,4,5],"type":"integer"},"Id":{"format":"int64","type":"integer"},"BankAccountId":{"format":"int64","type":"integer"}}},"KashFlow.Accounting.Model.Settings.VatSettings":{"type":"object","properties":{"VatRegistrationNumber":{"type":"string"},"Frequency":{"type":"string"},"IsVatRegistered":{"type":"boolean"},"IsConnectedToMtd":{"type":"boolean"},"IsOnlineFilingEnabled":{"type":"boolean"},"EnableOutsideSubmission":{"type":"boolean"},"EverConnectedToMtd":{"type":"boolean"},"PartnerExcludedVatReportAccess":{"type":"boolean"},"VatPeriodStartDate":{"format":"date-time","type":"string"},"VatPeriodEndDate":{"format":"date-time","type":"string"},"VatCapability":{"$ref":"#/definitions/KashFlow.Accounting.Model.Settings.VatCapability"},"IsFRS":{"type":"boolean"},"FRSRate":{"format":"double","type":"number"},"AccessTokenExpiryTime":{"format":"date-time","type":"string"},"RefreshTokenExpired":{"type":"boolean"},"DisplayMtdRecommendedModal":{"type":"boolean"},"SignedUpForMtd":{"type":"boolean"},"IsConfigured":{"type":"boolean"},"VatCashAccountingPurchases":{"type":"boolean"},"ExcludeECSalesListWithVatReturn":{"type":"boolean"},"IsHMRCServiceDown":{"type":"boolean"},"HmrcUsername":{"type":"string"},"HmrcPassword":{"type":"string"},"HmrcBranchNumber":{"type":"string"},"HmrcPostCode":{"type":"string"},"HmrcVATNumber":{"type":"string"},"PVABoxTextChangeFrom":{"format":"date-time","type":"string"},"RegisteredIn":{"type":"string"},"RegisteredState":{"format":"int32","type":"integer"},"PVAStartDate":{"format":"date-time","type":"string"},"PartnerEverConnectedToMtd":{"type":"boolean"}}},"KashFlow.Accounting.Model.Settings.VatCapability":{"type":"object","properties":{"InformationMessage":{"type":"boolean"},"VatError":{"$ref":"#/definitions/KashFlow.Accounting.Model.VAT.ErrorDetail"},"SubmitToHmrc":{"type":"boolean"},"SignUpToHmrc":{"type":"boolean"},"OnlineFilingPopup":{"type":"boolean"},"MarkAsSubmitted":{"type":"boolean"},"CreateVatReturn":{"type":"boolean"},"VatLiabilities":{"type":"boolean"},"ConnectToHmrc":{"type":"boolean"},"Report":{"type":"boolean"},"Dashboard":{"type":"boolean"},"SettingRedirect":{"type":"boolean"}}},"KashFlow.Accounting.Model.Settings.UpdateVatSettingsRequest":{"required":["VatRegistrationNumber","IsOnlineFilingEnabled","Frequency","RegisteredIn"],"type":"object","properties":{"VatRegistrationNumber":{"type":"string"},"IsOnlineFilingEnabled":{"type":"boolean"},"EnableOutsideSubmission":{"type":"boolean"},"Frequency":{"format":"int32","type":"integer"},"HmrcUsername":{"type":"string"},"HmrcPassword":{"type":"string"},"HmrcBranchNumber":{"type":"string"},"HmrcPostCode":{"type":"string"},"HmrcVATNumber":{"type":"string"},"ExcludeECSalesListWithVatReturn":{"type":"boolean"},"RegisteredIn":{"type":"string"}}},"KashFlow.Accounting.DTO.VAT.VatSettingsResponse":{"type":"object","properties":{"VatRegistrationNumber":{"type":"string"},"VatThresholdStatus":{"type":"string"},"RegisteredIn":{"type":"string"},"RegisteredState":{"type":"string"},"VatName":{"type":"string"},"VatRate":{"format":"double","type":"number"},"VatFrequency":{"$ref":"#/definitions/KashFlow.Accounting.DTO.VAT.VatFrequencyDetail"},"VatOnOverview":{"type":"boolean"},"CalculateTaxOnIndividualUnitPrice":{"type":"boolean"},"VatConfigured":{"type":"boolean"},"DefineProds":{"type":"boolean"},"IsVatRegistered":{"type":"boolean"},"EverConnectedToMTD":{"type":"boolean"},"SignedUpForMtd":{"type":"boolean"},"IsPartnerConnectedToMtd":{"type":"boolean"},"OnlineFiling":{"$ref":"#/definitions/KashFlow.Accounting.DTO.VAT.HMRCOnlineFilingDetails"},"LockTransactionAfterVat":{"$ref":"#/definitions/KashFlow.Accounting.DTO.VAT.LockTransactionAfterVatSetting"},"CashAccounting":{"$ref":"#/definitions/KashFlow.Accounting.DTO.VAT.CashAccounting"},"RemoveVATECMentions":{"type":"boolean"},"FlatRateScheme":{"$ref":"#/definitions/KashFlow.Accounting.DTO.VAT.FlatRateScheme"},"MOSSSettings":{"$ref":"#/definitions/KashFlow.Accounting.DTO.VAT.MOSSSettings"},"EnableOutsideSubmission":{"type":"boolean"},"PartnerEverConnectedToMtd":{"type":"boolean"}}},"KashFlow.Accounting.DTO.VAT.VatFrequencyDetail":{"type":"object","properties":{"Frequency":{"type":"string"},"MonthOfVatQuarter":{"type":"string"}}},"KashFlow.Accounting.DTO.VAT.HMRCOnlineFilingDetails":{"type":"object","properties":{"IsEnabled":{"type":"boolean"},"Username":{"type":"string"},"Password":{"type":"string"},"BranchNumber":{"type":"string"},"PostCode":{"type":"string"},"VATNumber":{"type":"string"},"ExcludeECSalesListWithVatReturn":{"type":"boolean"}}},"KashFlow.Accounting.DTO.VAT.LockTransactionAfterVatSetting":{"type":"object","properties":{"IsLocked":{"type":"boolean"},"PartnerControls":{"type":"boolean"}}},"KashFlow.Accounting.DTO.VAT.CashAccounting":{"type":"object","properties":{"IsInvoiceOnCashAccounting":{"type":"boolean"},"IsPurchaseOnCashAccounting":{"type":"boolean"},"RemoveCashAccounting":{"type":"boolean"}}},"KashFlow.Accounting.DTO.VAT.FlatRateScheme":{"type":"object","properties":{"RemoveVATFRSMentions":{"type":"boolean"},"VatRate":{"format":"double","type":"number"},"PriorVatRate":{"format":"double","type":"number"},"SalesCode":{"format":"int32","type":"integer"},"IsEnabled":{"type":"boolean"},"ChangeDate":{"type":"string"},"Nominals":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Nominal"}},"DigitalServiceCount":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.DTO.VAT.MOSSSettings":{"type":"object","properties":{"IsMOSSRegistered":{"type":"boolean"},"IsMOSSReturnTypeUnion":{"type":"boolean"},"MossFixedEstablishment":{"type":"boolean"}}},"KashFlow.Accounting.Model.Nominal":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Name":{"type":"string"},"Code":{"format":"int32","type":"integer"},"AutoFillLineItem":{"type":"boolean"},"Price":{"format":"double","type":"number"},"WholeSalePrice":{"format":"double","type":"number"},"ManageStockLevel":{"type":"boolean"},"QuantityInStock":{"format":"double","type":"number"},"StockWarningQuantity":{"format":"double","type":"number"},"IncludeInVATReturnBox8":{"type":"boolean"},"Special":{"format":"int32","type":"integer"},"Description":{"type":"string"},"VATRate":{"format":"double","type":"number"},"VATExempt":{"type":"boolean"},"Classification":{"type":"string"},"Archived":{"type":"boolean"},"DefaultProduct":{"$ref":"#/definitions/KashFlow.Accounting.Model.Product"},"ControlAccountClassification":{"type":"string"},"DigitalService":{"type":"boolean"},"ComplianceCode":{"type":"string"},"BsOption":{"format":"int32","type":"integer"},"Sa103Code":{"format":"double","type":"number"},"IsProduct":{"format":"int32","type":"integer"},"Disallowed":{"type":"boolean"},"Type":{"type":"string"},"NomType":{"format":"int32","type":"integer"},"PlOption":{"format":"int32","type":"integer"},"IRISCoACode":{"type":"string"},"IRISCoAName":{"type":"string"},"IsIRISCoA":{"type":"boolean"},"AllowDelete":{"type":"boolean"}}},"KashFlow.Accounting.Model.Product":{"type":"object","properties":{"Code":{"type":"string"},"NominalCode":{"format":"int32","type":"integer"},"Name":{"type":"string"},"Description":{"type":"string"},"AutoFillLineItem":{"type":"boolean"},"Price":{"format":"double","type":"number"},"WholeSalePrice":{"format":"double","type":"number"},"VATRate":{"format":"double","type":"number"},"VATExempt":{"type":"boolean"},"ManageStockLevel":{"type":"boolean"},"QuantityInStock":{"format":"int32","type":"integer"},"StockWarningQuantity":{"format":"int32","type":"integer"},"IsDefault":{"type":"boolean"},"InUse":{"type":"boolean"},"PurchaseNominalId":{"format":"int32","type":"integer"},"PurchaseSubNominalId":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.VAT.VatSettingsRequest":{"type":"object","properties":{"VatRegistrationNumber":{"type":"string"},"RegisteredIn":{"format":"int32","description":" 0 = NOTSET,  1 = UK,  2 = EU","enum":[0,1,2],"type":"integer"},"VatRate":{"format":"double","type":"number"},"VatFrequency":{"$ref":"#/definitions/KashFlow.Accounting.Model.Settings.VAT.VatFrequencyDetail"},"VatOnOverview":{"type":"boolean"},"CalculateTaxOnIndividualUnitPrice":{"type":"boolean"},"DefineProds":{"type":"boolean"},"SignedUpForMtd":{"type":"boolean"},"OnlineFiling":{"$ref":"#/definitions/KashFlow.Accounting.Model.VAT.HMRCOnlineFilingDetails"},"LockTransactionAfterVat":{"$ref":"#/definitions/KashFlow.Accounting.Model.Settings.VAT.LockTransactionAfterVatSetting"},"CashAccounting":{"$ref":"#/definitions/KashFlow.Accounting.Model.Settings.VAT.CashAccounting"},"FlatRateScheme":{"$ref":"#/definitions/KashFlow.Accounting.Model.Settings.VAT.FlatRateScheme"},"MOSSSettings":{"$ref":"#/definitions/KashFlow.Accounting.Model.VAT.MOSSSettings"},"EnableOutsideSubmission":{"type":"boolean"}}},"KashFlow.Accounting.Model.Settings.VAT.VatFrequencyDetail":{"type":"object","properties":{"Frequency":{"format":"int32","description":" 0 = Quarterly,  1 = Monthly","enum":[0,1],"type":"integer"},"MonthOfVatQuarter":{"format":"int32","description":" 0 = None,  1 = First,  2 = Second,  3 = Third","enum":[0,1,2,3],"type":"integer"}}},"KashFlow.Accounting.Model.VAT.HMRCOnlineFilingDetails":{"type":"object","properties":{"IsEnabled":{"type":"boolean"},"Username":{"type":"string"},"Password":{"type":"string"},"BranchNumber":{"type":"string"},"PostCode":{"type":"string"},"VATNumber":{"type":"string"},"ExcludeECSalesListWithVatReturn":{"type":"boolean"}}},"KashFlow.Accounting.Model.Settings.VAT.LockTransactionAfterVatSetting":{"type":"object","properties":{"IsLocked":{"type":"boolean"}}},"KashFlow.Accounting.Model.Settings.VAT.CashAccounting":{"type":"object","properties":{"IsInvoiceOnCashAccounting":{"type":"boolean"},"IsPurchaseOnCashAccounting":{"type":"boolean"}}},"KashFlow.Accounting.Model.Settings.VAT.FlatRateScheme":{"type":"object","properties":{"VatRate":{"format":"double","type":"number"},"PriorVatRate":{"format":"double","type":"number"},"SalesCode":{"format":"int32","type":"integer"},"IsEnabled":{"type":"boolean"},"ChangeDate":{"format":"date-time","type":"string"},"Nominals":{"type":"array","items":{"$ref":"#/definitions/KashFlow.Accounting.Model.Nominal"}},"DigitalServiceCount":{"format":"int32","type":"integer"}}},"KashFlow.Accounting.Model.VAT.MOSSSettings":{"type":"object","properties":{"IsMOSSRegistered":{"type":"boolean"},"IsMOSSReturnTypeUnion":{"type":"boolean"},"MossFixedEstablishment":{"type":"boolean"}}},"KashFlow.Accounting.Model.VatRates":{"type":"object","properties":{"VATId":{"format":"int32","type":"integer"},"VATRate":{"format":"double","type":"number"},"VATText":{"type":"string"}}},"KashFlow.Accounting.DTO.ViaPost.ViaPostBalance":{"type":"object","properties":{"Balance":{"format":"double","type":"number"}}},"KashFlow.Accounting.DTO.Base.ViaPostBase":{"type":"object","properties":{"Address":{"$ref":"#/definitions/KashFlow.Accounting.DTO.ViaPost.ViaPostAddress"},"FileName":{"type":"string"},"DocumentUrl":{"type":"string"}}},"KashFlow.Accounting.DTO.ViaPost.ViaPostAddress":{"type":"object","properties":{"Name":{"type":"string"},"Line5":{"type":"string"},"CountryCode":{"type":"string"},"Line1":{"type":"string"},"Line2":{"type":"string"},"Line3":{"type":"string"},"Line4":{"type":"string"},"PostCode":{"type":"string"},"CountryName":{"type":"string"}}},"KashFlow.Accounting.DTO.ViaPost.ViaPostResponse":{"type":"object","properties":{"Address":{"$ref":"#/definitions/KashFlow.Accounting.DTO.ViaPost.ViaPostAddress"},"Balance":{"format":"double","type":"number"},"FileName":{"type":"string"},"DocumentUrl":{"type":"string"}}}},"securityDefinitions":{"apiKey":{"type":"apiKey","description":"API Key Authentication","name":"Authorization","in":"header"}}}