openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 156 kB
JSON
{"openapi":"3.0.0","servers":[{"url":"https://app.bigredcloud.com/api"}],"info":{"description":"\r\n<div style='line-height: 30px;'>\r\n <strong>Welcome to the Big Red Cloud API</strong><br/>\r\n This API enables programmatic access to Big Red Cloud data.<br/>\r\n We have used Swagger to auto generate the API documentation on this page, and it also enables direct interaction with the API in this page. <br/>\r\n To get started, you will require an API Key - check out our guide at <a target='_blank' href='https://www.bigredcloud.com/support/generating-api-key-guide/'>https://www.bigredcloud.com/support/generating-api-key-guide/</a> for information on how to get one. <br/>\r\n Use the 'Enter API Key' button below to enter your API key and start interacting with your Big Red Cloud data right on this page. <br/>\r\n The API key will be stored in your browsers local storage for convenience, but you will be able to delete it at any time if you wish. <br/>\r\n For additional information on the API, check out our support article at <a target='_blank' href='https://www.bigredcloud.com/support/api/'>https://www.bigredcloud.com/support/api/</a><br/>\r\n</div>","title":"Big Red Cloud API","version":"v1","x-apisguru-categories":["financial"],"x-logo":{"url":"https://www.bigredcloud.com/wp-content/uploads/BRCfavicon.gif"},"x-origin":[{"format":"swagger","url":"https://app.bigredcloud.com/api/swagger/docs/v1","version":"2.0"}],"x-providerName":"bigredcloud.com"},"paths":{"/v1/accounts":{"get":{"operationId":"Accounts_Get","responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"Count":3,"Items":[{"accountGroup":"Sales","accountType":"Profit and Loss","code":"000","description":"SALES","id":355},{"accountGroup":"Sales","accountType":"Profit and Loss","code":"008","description":"SALES STOCK","id":428},{"accountGroup":"Other Income","accountType":"Profit and Loss","code":"050","description":"DISCOUNT RECEIVED","id":349}],"NextPageLink":""}}},"schema":{"$ref":"#/components/schemas/PageResult_AccountDto_"}}},"description":"OK"}},"summary":"Returns a list of company's Accounts. Supports OData querying protocol.\r\nFiltering is forbidden.\r\nOrdering is allowed by \"id\" and \"code\" fields.","tags":["Accounts"]}},"/v1/analysisCategories":{"get":{"operationId":"AnalysisCategories_Get","responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"Count":3,"Items":[{"accountCode":"000","accountId":355,"categoryTypeId":19,"description":"AnCat1","id":1,"orderIndex":1},{"accountCode":"000","accountId":355,"categoryTypeId":19,"description":"AnCat2","id":2,"orderIndex":2},{"accountCode":"000","accountId":355,"categoryTypeId":19,"description":"AnCat3","id":3,"orderIndex":3}],"NextPageLink":""}}},"schema":{"$ref":"#/components/schemas/PageResult_AnalysisCategoryDto_"}}},"description":"OK"}},"summary":"Returns a list of company's Analysis Categories. Supports OData querying protocol.\r\nFiltering is allowed by \"categoryTypeId\" field.\r\nOrdering is allowed by \"id\" and \"orderIndex\" fields.","tags":["AnalysisCategories"]}},"/v1/bankAccounts":{"get":{"operationId":"BankAccounts_Get","responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"Count":1,"Items":[{"acCode":"B1","accountName":"","accountNumber":"83700896","address":["Address Line 1","Address Line 2"],"bankFeedSource":0,"businessIdentifierCodes":"AIBKIE2D","categoryId":41704,"creditorScheme":"XXXX","details":"Bank_111111111111111111","id":1,"internationalBankAccountNumber":"IE67 BOFI 9027 0925 7277 59","isDefaultBank":false,"lastChq":"000005","nominalAcCode":"B101","oBalance":0,"sortCode":"900284","timestamp":"QUFBQUFBQUFDcXc9"}],"NextPageLink":""}}},"schema":{"$ref":"#/components/schemas/PageResult_BankAccountQueryDto_"}}},"description":"OK"}},"summary":"Returns a list of company's Bank Account. Supports OData querying protocol.\r\nFiltering is forbidden.\r\nOrdering is allowed by \"id\" and \"acCode\" fields.","tags":["BankAccounts"]},"post":{"operationId":"BankAccounts_Post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankAccountDto"}}},"description":"Information of Bank Account to create.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Creates a new Bank Account.","tags":["BankAccounts"]}},"/v1/bankAccounts/batch":{"put":{"operationId":"BankAccounts_ProcessBatch","requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/BatchItem_BankAccountDto_"},"type":"array"}}},"description":"Batch of Bank Accounts to process.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Processes a batch of Bank Accounts.","tags":["BankAccounts"]}},"/v1/bankAccounts/{id}":{"delete":{"operationId":"BankAccounts_Delete","parameters":[{"description":"Id of Bank Account to remove.","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Timestamp of Bank Account to remove. Should be encoded in Base64.","in":"query","name":"timestamp","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Removes an existing Bank Account.","tags":["BankAccounts"]},"get":{"parameters":[{"description":"Id of Bank Account to return.","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"acCode":"B1","accountName":"","accountNumber":"83700896","address":["Address Line 1","Address Line 2"],"bankFeedSource":0,"businessIdentifierCodes":"AIBKIE2D","categoryId":41704,"creditorScheme":"XXXX","details":"Bank_1","id":1,"internationalBankAccountNumber":"IE67 BOFI 9027 0925 7277 59","isDefaultBank":false,"lastChq":"000005","nominalAcCode":"B101","oBalance":0,"sortCode":"900284","timestamp":"QUFBQUFBQUFDcXc9"}}},"schema":{"$ref":"#/components/schemas/BankAccountDto"}}},"description":"OK"}},"summary":"Returns information about a single Bank Account.","tags":["BankAccounts"]},"put":{"operationId":"BankAccounts_Put","parameters":[{"description":"Id of Bank Account to update.","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankAccountDto"}}},"description":"Information of Bank Account to update.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Updates an existing Bank Account.","tags":["BankAccounts"]}},"/v1/bookTranTypes":{"get":{"operationId":"BookTranTypes_Get","responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"Count":5,"Items":[{"code":"","description":"Cash Receipt","id":1},{"code":"","description":"Cash Payment","id":2},{"code":"","description":"Cheques Entry","id":3},{"code":"","description":"Purchases Book Entry","id":4},{"code":"","description":"Sales Entry","id":5}],"NextPageLink":""}}},"schema":{"$ref":"#/components/schemas/PageResult_BookTranTypeDto_"}}},"description":"OK"}},"summary":"Returns a list of global Book Transactions' Types. Supports OData querying protocol.\r\nFiltering is forbidden.\r\nOrdering is allowed by \"id\" field.","tags":["BookTranTypes"]}},"/v1/cashPayments":{"get":{"operationId":"CashPayments_Get","responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"Count":1,"Items":[{"acCode":null,"acEntries":[{"accountCode":"CP01","analysisCategoryId":10433,"description":"Cash Pay 01","id":62741,"value":200}],"bankAccountCode":"BAK2","bankAccountId":11111,"bookTranTypeId":2,"customFields":[],"detailCollection":["test"],"discount":0,"entryDate":"2025-06-15T13:47:50.951Z","id":12345,"ledger":100,"lodgement":0,"note":"Supplier 1","plaidTransactionId":null,"procDate":"2025-06-15T13:47:50.951Z","supplierId":70599,"timestamp":"Z5K1u9RD2wg=","total":100}],"NextPageLink":""}}},"schema":{"$ref":"#/components/schemas/PageResult_CashPaymentQueryDto_"}}},"description":"OK"}},"summary":"Returns a list of company's Cash Payments. Supports OData querying protocol.\r\nFiltering is allowed by \"entryDate\" field.\r\nOrdering is allowed by \"id\" field.","tags":["CashPayments"]},"post":{"operationId":"CashPayments_Post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashPaymentDto"}}},"description":"Information of Cash Receipt to create.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Creates a new Cash Payment.","tags":["CashPayments"]}},"/v1/cashPayments/batch":{"put":{"operationId":"CashPayments_ProcessBatch","requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/BatchItem_CashPaymentDto_"},"type":"array"}}},"description":"Batch of Cash Receipts to process.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Processes a batch of Cash Payments.","tags":["CashPayments"]}},"/v1/cashPayments/{id}":{"delete":{"operationId":"CashPayments_Delete","parameters":[{"description":"Id of Cash Receipt to remove.","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Timestamp of Cash Receipt to remove. Should be encoded in Base64.","in":"query","name":"timestamp","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Removes an existing Cash Payment.","tags":["CashPayments"]},"get":{"parameters":[{"description":"Id of Cash Receipt to return.","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"acCode":null,"acEntries":[{"accountCode":"CP01","analysisCategoryId":10433,"description":"Cash Pay 01","id":62741,"value":200}],"bankAccountCode":"BAK2","bankAccountId":11111,"bookTranTypeId":2,"customFields":[],"detailCollection":["test"],"discount":0,"entryDate":"2025-06-15T13:47:50.951Z","id":12345,"ledger":100,"lodgement":0,"note":"Supplier 1","plaidTransactionId":null,"procDate":"2025-06-15T13:47:50.951Z","supplierId":70599,"timestamp":"rfS3u9RD2wg=","total":100}}},"schema":{"$ref":"#/components/schemas/CashPaymentDto"}}},"description":"OK"}},"summary":"Returns information about a single Cash Payment.","tags":["CashPayments"]},"put":{"operationId":"CashPayments_Put","parameters":[{"description":"Id of Cash Receipt to update.","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashPaymentDto"}}},"description":"Information of Cash Receipt to update.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Updates an existing Cash Payment.","tags":["CashPayments"]}},"/v1/cashReceipts":{"get":{"operationId":"CashReceipts_Get","responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"Count":1,"Items":[{"acCode":null,"acEntries":[{"accountCode":"000","analysisCategoryId":1,"description":"AnCat1","id":1,"value":30}],"bookTranTypeId":1,"customFields":[{"description":"acudf_1","id":1,"userDefinedFieldId":1,"value":"acudfv_1"}],"customerId":null,"detailCollection":["det_1","det_2","det_3"],"discount":0,"entryDate":"2025-06-15T13:47:50.951Z","id":1,"ledger":0,"note":"note1","plaidTransactionId":null,"procDate":"2025-06-15T13:47:50.951Z","timestamp":"f7m8u9RD2wg=","total":50,"unallocated":0,"vatEntries":[{"amount":50,"id":1,"percentage":15,"vatRateId":1}],"vatTypeId":null}],"NextPageLink":""}}},"schema":{"$ref":"#/components/schemas/PageResult_CashReceiptQueryDto_"}}},"description":"OK"}},"summary":"Returns a list of company's Cash Receipts. Supports OData querying protocol.\r\nFiltering is allowed by \"entryDate\" field.\r\nOrdering is allowed by \"id\" field.","tags":["CashReceipts"]},"post":{"operationId":"CashReceipts_Post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashReceiptDto"}}},"description":"Information of Cash Receipt to create.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Creates a new Cash Receipt.","tags":["CashReceipts"]}},"/v1/cashReceipts/batch":{"put":{"operationId":"CashReceipts_ProcessBatch","requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/BatchItem_CashReceiptDto_"},"type":"array"}}},"description":"Batch of Cash Receipts to process.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Processes a batch of Cash Receipts.","tags":["CashReceipts"]}},"/v1/cashReceipts/{id}":{"delete":{"operationId":"CashReceipts_Delete","parameters":[{"description":"Id of Cash Receipt to remove.","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Timestamp of Cash Receipt to remove. Should be encoded in Base64.","in":"query","name":"timestamp","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Removes an existing Cash Receipt.","tags":["CashReceipts"]},"get":{"parameters":[{"description":"Id of Cash Receipt to return.","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"acCode":null,"acEntries":[{"accountCode":"000","analysisCategoryId":1,"description":"AnCat1","id":1,"value":30}],"bookTranTypeId":1,"customFields":[{"description":"acudf_1","id":1,"userDefinedFieldId":1,"value":"acudfv_1"}],"customerId":null,"detailCollection":["det_1","det_2","det_3"],"discount":0,"entryDate":"2025-06-15T13:47:50.951Z","id":1,"ledger":0,"note":"note1","plaidTransactionId":null,"procDate":"2025-06-15T13:47:50.951Z","timestamp":"uhu/u9RD2wg=","total":50,"unallocated":0,"vatEntries":[{"amount":50,"id":1,"percentage":15,"vatRateId":1}],"vatTypeId":null}}},"schema":{"$ref":"#/components/schemas/CashReceiptDto"}}},"description":"OK"}},"summary":"Returns information about a single Cash Receipt.","tags":["CashReceipts"]},"put":{"operationId":"CashReceipts_Put","parameters":[{"description":"Id of Cash Receipt to update.","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashReceiptDto"}}},"description":"Information of Cash Receipt to update.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Updates an existing Cash Receipt.","tags":["CashReceipts"]}},"/v1/categoryTypes":{"get":{"operationId":"CategoryTypes_Get","responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"Count":1,"Items":[{"description":"Cash Receipts","id":17}],"NextPageLink":""}}},"schema":{"$ref":"#/components/schemas/PageResult_CategoryTypeDto_"}}},"description":"OK"}},"summary":"Returns a list of company's Category Types. Supports OData querying protocol.\r\nFiltering is forbidden.\r\nOrdering is allowed by \"id\" field.","tags":["CategoryTypes"]}},"/v1/companySettings":{"get":{"operationId":"CompanySettings_Get","responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"enableVOCRReporting":true,"id":20164,"useAllocations":true,"value":"","vocrSettingValue":false}}},"schema":{"$ref":"#/components/schemas/PageResult_CompanySettingDto_"}}},"description":"OK"}},"summary":"Returns a list of company settings. Supports OData querying protocol.\r\nFiltering is forbidden.","tags":["CompanySettings"]}},"/v1/companySetupConfig":{"get":{"operationId":"CompanySetupConfig_Get","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanySetupConfigViewModel"}}},"description":"OK"}},"summary":"Returns the company configuration settings.","tags":["CompanySetupConfig"]}},"/v1/companySetupConfig/getCompanyOptions":{"get":{"operationId":"CompanySetupConfig_GetCompanyOptions","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyOptionDto"}}},"description":"OK"}},"summary":"Returns the company option setting.","tags":["CompanySetupConfig"]}},"/v1/companySetupConfig/getFinancialYear":{"get":{"operationId":"CompanySetupConfig_GetFinancialYear","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinancialYearDto"}}},"description":"OK"}},"summary":"Returns the financial year.","tags":["CompanySetupConfig"]}},"/v1/customers":{"get":{"operationId":"Customers_Get","responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"Count":1,"Items":[{"accountName":"","accountNumber":"12345678","additionalEmails":["email2@example.com","email2@example.com"],"address":["Address Line 1","Address Line 2"],"authCode":"VATEXCODE222","bank":{"branch":"Bank","id":1,"name":"bank Name","sortCode":"B01"},"businessIdentifierCode":"AIBI02","code":"12345678","contact":"John Smith","delivery":["Delivery 1","Delivery 2"],"eFTReference":"Reference","email":"customer@email.com","fax":"1234567890","id":10589,"internationalBankAccountNumber":"1233432532","mobile":"1234567890","name":"Customer Name 1","ourCode":"OURCODE111","ownerTypeId":1,"phone":"1234596970","timestamp":"yULGu9RD2wg=","vatAnalysisTypeId":1,"vatReg":"VATCODE0001","vatType":2}],"NextPageLink":""}}},"schema":{"$ref":"#/components/schemas/PageResult_CustomerQueryDto_"}}},"description":"OK"}},"summary":"Returns a list of company's Customers. Supports OData querying protocol.\r\nFiltering is forbidden.\r\nOrdering is allowed by \"id\" and \"code\" fields.","tags":["Customers"]},"post":{"operationId":"Customers_Post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerDto"}}},"description":"Information of Customer to create.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Creates a new Customer.","tags":["Customers"]}},"/v1/customers/batch":{"put":{"operationId":"Customers_ProcessBatch","requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/BatchItem_CustomerDto_"},"type":"array"}}},"description":"Batch of Customers to process.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Processes a batch of Customers.","tags":["Customers"]}},"/v1/customers/{id}":{"delete":{"operationId":"Customers_Delete","parameters":[{"description":"Id of Customer to remove.","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Timestamp of Customer to remove. Should be encoded in Base64.","in":"query","name":"timestamp","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Removes an existing Customer.","tags":["Customers"]},"get":{"parameters":[{"description":"Id of Customer to return.","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"If \"true\" then Customer's ledger balance will be calculated; otherwise balance will be returned as 0.","in":"query","name":"needBalance","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerDto"}}},"description":"OK"}},"summary":"Returns information about a single Customer. You may specify that Customer's ledger balance should be calculated.","tags":["Customers"]},"put":{"operationId":"Customers_Put","parameters":[{"description":"Id of Customer to update.","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerDto"}}},"description":"Information of Customer to update.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Updates an existing Customer.","tags":["Customers"]}},"/v1/customers/{itemId}/accountTrans":{"get":{"operationId":"Customers_GetAccountTrans","parameters":[{"description":"Id of Customer to return account transaction.","in":"path","name":"itemId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":[{"bookTranId":0,"bookTranTypeId":0,"bookTransactionReference":"O/Bal","bookTypeDesc":"Opening Balance","credit":0,"debit":30,"id":2,"procDate":"2025-06-15T13:47:50.951Z"},{"bookTranId":0,"bookTranTypeId":0,"bookTransactionReference":"0000001","bookTypeDesc":"Bank Payment","credit":0,"debit":10,"id":9,"procDate":"2025-06-15T13:47:50.951Z"}]}},"schema":{"items":{"$ref":"#/components/schemas/AccountTranDto"},"type":"array"}}},"description":"OK"}},"summary":"Returns a list of Customer's account transactions.","tags":["Customers"]}},"/v1/customers/{itemId}/openingBalance":{"get":{"operationId":"Customers_GetOpeningBalance","parameters":[{"description":"Id of Customer to return opening balances.","in":"path","name":"itemId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"currentMonth":10,"oneMonthOld":20,"threeMonthsOld":40,"twoMonthsOld":30}}},"schema":{"$ref":"#/components/schemas/OwnerOpeningBalanceInPeriodsDto"}}},"description":"OK"}},"summary":"Returns a Customer's opening balances, calculated for the next periods: current month, one month old, two months old, three and more months old.","tags":["Customers"]}},"/v1/customers/{itemId}/openingBalanceList":{"get":{"operationId":"Customers_GetOpeningBalanceList","parameters":[{"description":"Id of Customer to return opening balances transaction.","in":"path","name":"itemId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":[{"entryDate":"2025-06-15T13:47:50.951Z","id":1,"procDate":"2025-06-15T13:47:50.951Z","reference":"O/Bal","timestamp":"xWnNu9RD2wg=","total":10,"totalVAT":1.3,"unpaid":0,"vatEntries":[{"amount":8.7,"vatRateId":1}]},{"entryDate":"2025-06-15T13:47:50.951Z","id":2,"procDate":"2025-06-15T13:47:50.951Z","reference":"O/Bal","timestamp":"xWnNu9RD2wg=","total":20,"totalVAT":3.33,"unpaid":0,"vatEntries":[{"amount":16.77,"vatRateId":2}]}]}},"schema":{"items":{"$ref":"#/components/schemas/OwnerOpeningBalanceDto"},"type":"array"}}},"description":"OK"}},"summary":"Returns a list of Customer's opening balance transactions.","tags":["Customers"]}},"/v1/customers/{itemId}/quotes":{"get":{"operationId":"Customers_GetQuotes","parameters":[{"description":"Id of Customer to return quotes.","in":"path","name":"itemId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/QuoteDto"},"type":"array"}}},"description":"OK"}},"summary":"Returns a list of Customer's quotes.","tags":["Customers"]}},"/v1/email/sendEmailStatement":{"post":{"operationId":"Email_SendEmailStatement","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailStatementDto"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Sends a Statement email.\r\nIf \"toAddress\" is not empty then email will be sent to this address. Otherwise email will be sent to Statement Customer's address.","tags":["Email"]}},"/v1/email/sendQuote":{"post":{"operationId":"Email_SendQuote","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailQuoteDto"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Sends a Quote email.\r\nIf \"toAddress\" is not empty then email will be sent to this address. Otherwise email will be sent to Statement Customer's address.","tags":["Email"]}},"/v1/email/sendSalesInvoice":{"post":{"operationId":"Email_SendSalesInvoice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesInvoiceEmailInfoDto"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Sends a Sales Invoice email.\r\nIf \"toAddress\" is not empty then email will be sent to this address. Otherwise email will be sent to Sales Invoice Customer's address.","tags":["Email"]}},"/v1/ownerTypeGroups":{"get":{"operationId":"OwnerTypeGroups_Get","responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"Count":2,"Items":[{"description":"Customer","id":1},{"description":"Supplier","id":2}],"NextPageLink":""}}},"schema":{"$ref":"#/components/schemas/PageResult_OwnerTypeGroupDto_"}}},"description":"OK"}},"summary":"Returns a list of global Owner Type Groups. Supports OData querying protocol.\r\nFiltering is forbidden.\r\nOrdering is allowed by \"id\" field.","tags":["OwnerTypeGroups"]}},"/v1/ownerTypes":{"get":{"operationId":"OwnerTypes_Get","responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"Count":3,"Items":[{"description":"Prospect","id":1,"recordTypeGroupId":1},{"description":"Customer","id":2,"recordTypeGroupId":1},{"description":"Supplier","id":3,"recordTypeGroupId":2}],"NextPageLink":""}}},"schema":{"$ref":"#/components/schemas/PageResult_OwnerTypeDto_"}}},"description":"OK"}},"summary":"Returns a list of global Owner Types. Supports OData querying protocol.\r\nFiltering is forbidden.\r\nOrdering is allowed by \"id\" field.","tags":["OwnerTypes"]}},"/v1/payments":{"get":{"operationId":"Payments_Get","responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"Count":1,"Items":[{"acCode":"C1","acEntries":[],"bankAccountCode":"B1","bankAccountId":1,"bookTranTypeId":3,"customFields":[{"description":"F1","id":1,"userDefinedFieldId":1,"value":"f1"},{"description":"F2","id":2,"userDefinedFieldId":2,"value":"f2"}],"detailCollection":["d1","d2"],"discount":2,"entryDate":"2025-06-15T13:47:50.952Z","id":2,"note":"123","plaidTransactionId":null,"procDate":"2025-06-15T13:47:50.952Z","reference":"000002","supplierId":2,"timestamp":"pVXZu9RD2wg=","total":155,"transferBankCode":"","transferBankId":1,"unallocated":155}],"NextPageLink":""}}},"schema":{"$ref":"#/components/schemas/PageResult_PaymentQueryDto_"}}},"description":"OK"}},"summary":"Returns a list of company's Payments. Supports OData querying protocol.\r\nFiltering is allowed by \"entryDate\" field.\r\nOrdering is allowed by \"id\" field.","tags":["Payments"]},"post":{"operationId":"Payments_Post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentDto"}}},"description":"Information of Payment to create.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Creates a new Payment.","tags":["Payments"]}},"/v1/payments/batch":{"put":{"operationId":"Payments_ProcessBatch","requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/BatchItem_PaymentDto_"},"type":"array"}}},"description":"Batch of Payments to process.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Processes a batch of Payments.","tags":["Payments"]}},"/v1/payments/{id}":{"delete":{"operationId":"Payments_Delete","parameters":[{"description":"Id of Payment to remove.","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Timestamp of Payment to remove. Should be encoded in Base64.","in":"query","name":"timestamp","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Removes an existing Payment.","tags":["Payments"]},"get":{"parameters":[{"description":"Id of Payment to return.","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"acCode":"C1","acEntries":[],"bankAccountCode":"B1","bankAccountId":1,"bookTranTypeId":3,"customFields":[{"description":"F1","id":1,"userDefinedFieldId":1,"value":"f1"},{"description":"F2","id":2,"userDefinedFieldId":2,"value":"f2"}],"detailCollection":["d1","d2"],"discount":2,"entryDate":"2025-06-15T13:47:50.952Z","id":2,"note":"123","plaidTransactionId":null,"procDate":"2025-06-15T13:47:50.952Z","reference":"000002","supplierId":2,"timestamp":"M7jbu9RD2wg=","total":155,"transferBankCode":"","transferBankId":1,"unallocated":155}}},"schema":{"$ref":"#/components/schemas/PaymentDto"}}},"description":"OK"}},"summary":"Returns information about a single Payments.","tags":["Payments"]},"put":{"operationId":"Payments_Put","parameters":[{"description":"Id of Payment to update.","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentDto"}}},"description":"Information of Payment to update.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Updates an existing Payment.","tags":["Payments"]}},"/v1/productTypes":{"get":{"operationId":"ProductTypes_Get","responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"Count":3,"Items":[{"description":"Prospect","id":1,"recordTypeGroupId":1},{"description":"Customer","id":2,"recordTypeGroupId":1},{"description":"Supplier","id":3,"recordTypeGroupId":2}],"NextPageLink":""}}},"schema":{"$ref":"#/components/schemas/PageResult_OwnerTypeDto_"}}},"description":"OK"}},"summary":"Returns a list of global Product Types. Supports OData querying protocol.\r\nFiltering is forbidden.\r\nOrdering is allowed by \"id\" field.","tags":["ProductTypes"]}},"/v1/products":{"get":{"operationId":"Products_Get","responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"Count":1,"Items":[{"details":["det1","det2","det3"],"grossUnitPrice":false,"hasDefaultVatRate":false,"id":9,"productTypeId":0,"stockCode":"PRO1","timestamp":"fRreu9RD2wg=","unitPrice":100,"vatAnalysisTypeId":1,"vatRateId":null}],"NextPageLink":""}}},"schema":{"$ref":"#/components/schemas/PageResult_ProductDto_"}}},"description":"OK"}},"summary":"Returns a list of company's Products. Supports OData querying protocol.\r\nFiltering is forbidden.\r\nOrdering is allowed by \"id\" and \"stockCode\" fields.","tags":["Products"]},"post":{"operationId":"Products_Post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDto"}}},"description":"Information of Product to create.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Creates a new Product.","tags":["Products"]}},"/v1/products/batch":{"put":{"operationId":"Products_ProcessBatch","requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/BatchItem_ProductDto_"},"type":"array"}}},"description":"Batch of Products to process.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Processes a batch of Products.","tags":["Products"]}},"/v1/products/{id}":{"delete":{"operationId":"Products_Delete","parameters":[{"description":"Id of Product to remove.","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Timestamp of Product to remove. Should be encoded in Base64.","in":"query","name":"timestamp","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Removes an existing Product.","tags":["Products"]},"get":{"parameters":[{"description":"Id of Product to return.","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"details":["det1","det2","det3"],"grossUnitPrice":false,"hasDefaultVatRate":false,"id":9,"productTypeId":0,"stockCode":"PRO1","timestamp":"fRreu9RD2wg=","unitPrice":100,"vatAnalysisTypeId":1,"vatRateId":null}}},"schema":{"$ref":"#/components/schemas/ProductDto"}}},"description":"OK"}},"summary":"Returns information about a single Product.","tags":["Products"]},"put":{"operationId":"Products_Put","parameters":[{"description":"Id of Product to update.","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDto"}}},"description":"Information of Product to update.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Updates an existing Product.","tags":["Products"]}},"/v1/purchases":{"get":{"operationId":"Purchases_Get","responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"Count":1,"Items":[{"acCode":"SUP3","acEntries":[{"accountCode":"PU03","analysisCategoryId":10441,"description":"PUR 3","id":12518,"value":90.91}],"bookTranTypeId":4,"customFields":[],"detailCollection":[],"entryDate":"2025-06-15T13:47:50.952Z","id":13380,"isDiscrepancyAccepted":null,"netGoods":0,"netServices":0,"note":"Supplier 3","postponedAccounting":false,"procDate":"2025-06-15T13:47:50.952Z","reference":"000001","supplierId":10173,"timestamp":"u3zgu9RD2wg=","total":100,"totalNet":90.91,"totalVAT":9.09,"unallocated":100,"unpaid":100,"vatEntries":[{"amount":90.91,"id":12267,"percentage":10,"vatRateId":10317}],"vatTypeId":1}],"NextPageLink":""}}},"schema":{"$ref":"#/components/schemas/PageResult_PurchaseQueryDto_"}}},"description":"OK"}},"summary":"Returns a list of company's Purchases. Supports OData querying protocol.\r\nFiltering is allowed by \"entryDate\" field.\r\nOrdering is allowed by \"id\" field.","tags":["Purchases"]},"post":{"operationId":"Purchases_Post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseDto"}}},"description":"Information of Purchase to create.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Creates a new Purchase.","tags":["Purchases"]}},"/v1/purchases/batch":{"put":{"operationId":"Purchases_ProcessBatch","requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/BatchItem_PurchaseDto_"},"type":"array"}}},"description":"Batch of Purchases to process.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Processes a batch of Purchases.","tags":["Purchases"]}},"/v1/purchases/{id}":{"delete":{"operationId":"Purchases_Delete","parameters":[{"description":"Id of Purchase to remove.","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Timestamp of Purchase to remove. Should be encoded in Base64.","in":"query","name":"timestamp","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Removes an existing Purchase.","tags":["Purchases"]},"get":{"parameters":[{"description":"Id of Purchase to return.","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"acCode":"SUP3","acEntries":[{"accountCode":"PU03","analysisCategoryId":10441,"description":"PUR 3","id":12518,"value":90.91}],"bookTranTypeId":4,"customFields":[],"detailCollection":[],"entryDate":"2025-06-15T13:47:50.952Z","id":13380,"isDiscrepancyAccepted":false,"netGoods":0,"netServices":0,"note":"Supplier 3","postponedAccounting":false,"procDate":"2025-06-15T13:47:50.952Z","reference":"000001","supplierId":10173,"timestamp":"QN/iu9RD2wg=","total":100,"totalNet":90.91,"totalVAT":9.09,"unallocated":100,"unpaid":100,"vatEntries":[{"amount":90.91,"id":12267,"percentage":10,"vatRateId":10317}],"vatTypeId":1}}},"schema":{"$ref":"#/components/schemas/PurchaseDto"}}},"description":"OK"}},"summary":"Returns information about a single Purchases.","tags":["Purchases"]},"put":{"operationId":"Purchases_Put","parameters":[{"description":"Id of Purchase to update.","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseDto"}}},"description":"Information of Purchase to update.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Updates an existing Purchase.","tags":["Purchases"]}},"/v1/quotes":{"get":{"operationId":"Quote_Get","responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"Count":1,"Items":[{"acCode":null,"closedDate":null,"comments":"Sample","companyId":40449,"customFields":null,"customerOwnerId":70583,"customerOwnerName":"Customer 1","ddNumber":"Sample","deliveryList":null,"deliveryTo":null,"entryDate":"2025-06-15T13:47:50.952Z","id":1,"layoutType":1,"note":null,"poNumber":"Sample","procDate":"2025-06-15T13:47:50.952Z","productTrans":[{"acEntries":[{"accountCode":"sample","analysisCategoryId":40888,"companyId":40449,"id":1,"quoteProductTranId":40277,"value":100}],"amount":10,"companyId":40449,"id":40277,"percentage":0,"productCode":"PRO1","productId":20107,"quantity":1,"tranNotes":["Product"],"unitPrice":100,"vatAmount":10,"vatAnalysisTypeId":0,"vatRateId":30657}],"reference":"000032","saleInvoiceId":30044,"saleRepCode":null,"saleRepId":75783,"timeStamp":"lEHlu9RD2wg=","total":110,"totalNet":100,"totalVat":10,"vatTypeId":1}],"NextPageLink":""}}},"schema":{"$ref":"#/components/schemas/PageResult_QuoteDto_"}}},"description":"OK"}},"summary":"Returns a list of company's Quotes.\r\nFiltering is forbidden.\r\nOrdering is allowed by \"id\".","tags":["Quote"]},"post":{"operationId":"Quote_Post","requestBody":{"$ref":"#/components/requestBodies/QuoteDto"},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Creates a new Quote.","tags":["Quote"]}},"/v1/quotes/batch":{"put":{"operationId":"Quote_ProcessBatch","requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/BatchItem_QuoteDto_"},"type":"array"}}},"description":"Batch of Quote to process.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Processes a batch of Quote.","tags":["Quote"]}},"/v1/quotes/close/{id}":{"put":{"operationId":"Quote_Close","parameters":[{"description":"Id of Quote to close","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Close a Quote.","tags":["Quote"]}},"/v1/quotes/createQuoteWithGeneratingReference":{"post":{"operationId":"Quote_Post_CreateQuoteWithGeneratingReference","requestBody":{"$ref":"#/components/requestBodies/QuoteDto"},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Creates a new Quote with auto generating reference.","tags":["Quote"]}},"/v1/quotes/generateSaleInvoice":{"post":{"operationId":"Quote_Post_GenerateSaleInvoice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuoteGeneratingInvoiceDto"}}},"description":"Id of Quote to generate","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Generate a sale invoice from a Quote.\r\nWhen sale invoice is empty, new sale invoice will be generated from Quote.","tags":["Quote"]}},"/v1/quotes/reopen/{id}":{"put":{"operationId":"Quote_Reopen","parameters":[{"description":"Id of Quote to reopen","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Reopen a Quote.","tags":["Quote"]}},"/v1/quotes/{id}":{"delete":{"operationId":"Quote_Delete","parameters":[{"description":"Id of Quote to remove.","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Timestamp of Quote to remove. Should be encoded in Base64.","in":"query","name":"timestamp","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Removes an existing Quote.","tags":["Quote"]},"get":{"parameters":[{"description":"Id of Sale Rep to return.","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"acCode":null,"closedDate":null,"comments":"Sample","companyId":40449,"customFields":null,"customerOwnerId":70583,"customerOwnerName":"Customer 1","ddNumber":"Sample","deliveryList":null,"deliveryTo":null,"entryDate":"2025-06-15T13:47:50.952Z","id":1,"layoutType":1,"note":null,"poNumber":"Sample","procDate":"2025-06-15T13:47:50.952Z","productTrans":[{"acEntries":[{"accountCode":"sample","analysisCategoryId":40888,"companyId":40449,"id":1,"quoteProductTranId":40277,"value":100}],"amount":10,"companyId":40449,"id":40277,"percentage":0,"productCode":"PRO1","productId":20107,"quantity":1,"tranNotes":["Product"],"unitPrice":100,"vatAmount":10,"vatAnalysisTypeId":0,"vatRateId":30657}],"reference":"000032","saleInvoiceId":30044,"saleRepCode":null,"saleRepId":75783,"timeStamp":"SAbqu9RD2wg=","total":110,"totalNet":100,"totalVat":10,"vatTypeId":1}}},"schema":{"$ref":"#/components/schemas/QuoteDto"}}},"description":"OK"}},"summary":"Returns information about a single Quote.","tags":["Quote"]},"put":{"operationId":"Quote_Put","parameters":[{"description":"Id of Quote to update.","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuoteDto"}}},"description":"Information of Quote to update.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Updates an existing Quote.","tags":["Quote"]}},"/v1/sales":{"get":{"operationId":"Sales_Get","responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"Count":1,"Items":[{"acCode":"code","acEntries":[{"accountCode":"000","analysisCategoryId":1,"description":"AnCat 1","id":1,"value":20},{"accountCode":"000","analysisCategoryId":1,"description":"AnCat 2","id":2,"value":10}],"bookTranTypeId":6,"customFields":[{"description":"acudf_1","id":1,"userDefinedFieldId":1,"value":"acudfv_1"}],"customerId":1,"details":"detail_1","entryDate":"2025-06-15T13:47:50.952Z","id":1,"loType":"1","note":"note_1","procDate":"2025-06-15T13:47:50.952Z","reference":"000001","timestamp":"C8vuu9RD2wg=","total":82.5,"totalNet":70,"totalVAT":12.5,"unpaid":12.5,"vatEntries":[{"amount":30,"id":1,"percentage":15,"vatRateId":1},{"amount":40,"id":2,"percentage":20,"vatRateId":2}],"vatTypeId":1}],"NextPageLink":""}}},"schema":{"$ref":"#/components/schemas/PageResult_SalesQueryDto_"}}},"description":"OK"}},"summary":"Returns a list of company's Sales Entries, Sales Invoices and Sales Credit Notes. Supports OData querying protocol.\r\nFiltering is allowed by \"entryDate\" field.\r\nOrdering is allowed by \"id\" field.","tags":["Sales"]}},"/v1/salesCreditNotes":{"get":{"operationId":"SalesCreditNotes_Get","responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"Count":1,"Items":[{"acCode":"CUS3","bookTranTypeId":7,"customFields":[{"description":"acudf_1","id":1,"userDefinedFieldId":1,"value":"acudfv_1"},{"description":"acudf_2","id":2,"userDefinedFieldId":1,"value":"acudfv_2"}],"customerId":70585,"deliveryTo":["dt_1","dt_2"],"details":"detail_1","entryDate":"2025-06-15T13:47:50.952Z","id":75813,"loType":"1","netGoods":null,"netServices":null,"note":"Customer 3","ourReference":"ddNumber_1","procDate":"2025-06-15T13:47:50.952Z","productTrans":[{"acEntries":[{"accountCode":"SA02","analysisCategoryId":40889,"description":"AnCat1","id":73455,"value":-200}],"amount":-220,"amountNet":-200,"id":51820,"percentage":10,"productCode":"PRO2","productId":20108,"quantity":-1,"tranNotes":["tn_1","tn_2"],"unitPrice":200,"vat":-20,"vatAnalysisTypeId":0,"vatRateId":30657}],"quoteId":null,"reference":"000001","saleRepCode":null,"saleRepId":33110,"timestamp":"DfL1u9RD2wg=","total":-220,"totalNet":-200,"totalVAT":-20,"unpaid":-220,"vatTypeId":1,"yourReference":"poNumber_1"}],"NextPageLink":""}}},"schema":{"$ref":"#/components/schemas/PageResult_SalesCreditNoteQueryDto_"}}},"description":"OK"}},"summary":"Returns a list of company's Sales Credit Notes. Supports OData querying protocol.\r\nFiltering is allowed by \"entryDate\" field.\r\nOrdering is allowed by \"id\" field.","tags":["SalesCreditNotes"]},"post":{"operationId":"SalesCreditNotes_Post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesInvoiceCreditNoteDto"}}},"description":"Information of Sales Credit Note to create.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Creates a new Sales Credit Note.","tags":["SalesCreditNotes"]}},"/v1/salesCreditNotes/batch":{"put":{"operationId":"SalesCreditNotes_ProcessBatch","requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/BatchItem_SalesInvoiceCreditNoteDto_"},"type":"array"}}},"description":"Batch of Sales Credit Notes to process.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Processes a batch of Sales Credit Notes.","tags":["SalesCreditNotes"]}},"/v1/salesCreditNotes/{id}":{"delete":{"operationId":"SalesCreditNotes_Delete","parameters":[{"description":"Id of Sales Credit Note to remove.","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Timestamp of Sales Credit Note to remove. Should be encoded in Base64.","in":"query","name":"timestamp","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Removes an existing Sales Credit Note.","tags":["SalesCreditNotes"]},"get":{"parameters":[{"description":"Id of Sales Credit Note to return.","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"acCode":"CUS3","bookTranTypeId":7,"customFields":[{"description":"acudf_1","id":1,"userDefinedFieldId":1,"value":"acudfv_1"},{"description":"acudf_2","id":2,"userDefinedFieldId":1,"value":"acudfv_2"}],"customerId":70585,"deliveryTo":["dt_1","dt_2"],"details":"detail_1","entryDate":"2025-06-15T13:47:50.952Z","id":75813,"loType":"1","netGoods":null,"netServices":null,"note":"Customer 3","ourReference":"ddNumber_1","procDate":"2025-06-15T13:47:50.952Z","productTrans":[{"acEntries":[{"accountCode":"SA02","analysisCategoryId":40889,"description":"AnCat1","id":73455,"value":-200}],"amount":-220,"amountNet":-200,"id":51820,"percentage":10,"productCode":"PRO2","productId":20108,"quantity":-1,"tranNotes":["tn_1","tn_2"],"unitPrice":200,"vat":-20,"vatAnalysisTypeId":0,"vatRateId":30657}],"quoteId":null,"reference":"000001","saleRepCode":null,"saleRepId":33110,"timestamp":"DfL1u9RD2wg=","total":-220,"totalNet":-200,"totalVAT":-20,"unpaid":-220,"vatTypeId":1,"yourReference":"poNumber_1"}}},"schema":{"$ref":"#/components/schemas/SalesInvoiceCreditNoteDto"}}},"description":"OK"}},"summary":"Returns information about a single Sales Credit Note.","tags":["SalesCreditNotes"]},"put":{"operationId":"SalesCreditNotes_Put","parameters":[{"description":"Id of Sales Credit Note to update.","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesInvoiceCreditNoteDto"}}},"description":"Information of Sales Credit Note to update.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"}},"summary":"Updates an existing Sales Credit Note.","tags":["SalesCreditNotes"]}},"/v1/salesEntries":{"get":{"operationId":"SalesEntries_Get","responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"Count":1,"Items":[{"acCode":"code","acEntries":[{"accountCode":"SA01","analysisCategoryId":40888,"description":"SAL 1","id":73450,"val