|
| 1 | +# @codat/accounting |
| 2 | + |
| 3 | +<!-- Start SDK Installation --> |
| 4 | +## SDK Installation |
| 5 | + |
| 6 | +### NPM |
| 7 | + |
| 8 | +```bash |
| 9 | +npm add @codat/accounting |
| 10 | +``` |
| 11 | + |
| 12 | +### Yarn |
| 13 | + |
| 14 | +```bash |
| 15 | +yarn add @codat/accounting |
| 16 | +``` |
| 17 | +<!-- End SDK Installation --> |
| 18 | + |
| 19 | +## SDK Example Usage |
| 20 | +<!-- Start SDK Example Usage --> |
| 21 | +```typescript |
| 22 | +import { |
| 23 | + GetCreateUpdateAccountTransactionsModelRequest, |
| 24 | + GetCreateUpdateAccountTransactionsModelResponse |
| 25 | +} from "@codat/accounting/dist/sdk/models/operations"; |
| 26 | + |
| 27 | +import { AxiosError } from "axios"; |
| 28 | +import { Codat } from "@codat/accounting"; |
| 29 | +const sdk = new Codat({ |
| 30 | + security: { |
| 31 | + authHeader: "YOUR_API_KEY_HERE", |
| 32 | + }, |
| 33 | +}); |
| 34 | + |
| 35 | +const req: GetCreateUpdateAccountTransactionsModelRequest = { |
| 36 | + pathParams: { |
| 37 | + accountTransactionId: "unde", |
| 38 | + companyId: "deserunt", |
| 39 | + connectionId: "porro", |
| 40 | + }, |
| 41 | +}; |
| 42 | + |
| 43 | +sdk.accountTransactions.getCreateUpdateAccountTransactionsModel(req).then((res: GetCreateUpdateAccountTransactionsModelResponse | AxiosError) => { |
| 44 | + // handle response |
| 45 | +}); |
| 46 | +``` |
| 47 | +<!-- End SDK Example Usage --> |
| 48 | + |
| 49 | +<!-- Start SDK Available Operations --> |
| 50 | +## SDK Available Operations |
| 51 | + |
| 52 | + |
| 53 | +### accountTransactions |
| 54 | + |
| 55 | +* `getCreateUpdateAccountTransactionsModel` - Get account transaction |
| 56 | +* `listAccountTransactions` - List account transactions |
| 57 | + |
| 58 | +### accounts |
| 59 | + |
| 60 | +* `createAccount` - Create account |
| 61 | +* `getAccount` - Get account |
| 62 | +* `getAccounts` - List accounts |
| 63 | +* `getCreateChartOfAccountsModel` - Get create account model |
| 64 | + |
| 65 | +### bankAccountTransactions |
| 66 | + |
| 67 | +* `getBankAccountPushOptions` - List push options for bank account bank transactions |
| 68 | +* `listBankAccountTransactions` - List bank transactions for bank account |
| 69 | +* `listBankTransactions` - List all bank transactions |
| 70 | +* `postBankTransactions` - Create bank transactions |
| 71 | + |
| 72 | +### bankAccounts |
| 73 | + |
| 74 | +* `createBankAccount` - Create bank account |
| 75 | +* `getAllBankAccount` - Get bank account |
| 76 | +* `getBankAccount` - Get bank account |
| 77 | +* `getCreateUpdateBankAccountsModel` - Get create/update bank account model |
| 78 | +* `listBankAccounts` - List bank accounts |
| 79 | +* `putBankAccount` - Update bank account |
| 80 | + |
| 81 | +### billCreditNotes |
| 82 | + |
| 83 | +* `createBillCreditNote` - Create bill credit note |
| 84 | +* `getBillCreditNote` - Get bill credit note |
| 85 | +* `getCreateUpdateBillCreditNotesModel` - Get create/update bill credit note model |
| 86 | +* `listBillCreditNotes` - List bill credit notes |
| 87 | +* `updateBillCreditNote` - Update bill credit note |
| 88 | + |
| 89 | +### billPayments |
| 90 | + |
| 91 | +* `createBillPayment` - Create bill payments |
| 92 | +* `deleteCompaniesCompanyIdConnectionsConnectionIdPushBillPaymentsBillPaymentId` - Delete bill payment |
| 93 | +* `getBillPayments` - Get bill payment |
| 94 | +* `getCreateBillPaymentsModel` - Get create bill payment model |
| 95 | +* `listBillPayments` - List bill payments |
| 96 | + |
| 97 | +### bills |
| 98 | + |
| 99 | +* `createBill` - Create bill |
| 100 | +* `createBillAttachments` - Create bill attachments |
| 101 | +* `deleteCompaniesCompanyIdConnectionsConnectionIdPushBillsBillId` - Delete bill |
| 102 | +* `downloadBillAttachment` - Download bill attachment |
| 103 | +* `getBill` - Get bill |
| 104 | +* `getBillAttachment` - Get bill attachment |
| 105 | +* `getBillAttachments` - List bill attachments |
| 106 | +* `getCreateUpdateBillsModel` - Get create/update bill model |
| 107 | +* `listBills` - List bills |
| 108 | +* `updateBill` - Update bill |
| 109 | + |
| 110 | +### companyInfo |
| 111 | + |
| 112 | +* `getCompanyInfo` - Get company info |
| 113 | +* `postSyncInfo` - Refresh company info |
| 114 | + |
| 115 | +### creditNotes |
| 116 | + |
| 117 | +* `createCreditNote` - Update creditNote |
| 118 | +* `getCreateUpdateCreditNotesModel` - Get create/update credit note model |
| 119 | +* `getCreditNote` - Get credit note |
| 120 | +* `listCreditNotes` - List credit notes |
| 121 | +* `pushCreditNote` - Create credit note |
| 122 | + |
| 123 | +### customers |
| 124 | + |
| 125 | +* `createCustomer` - Create customer |
| 126 | +* `downloadCustomerAttachment` - Download customer attachment |
| 127 | +* `getCreateUpdateCustomersModel` - Get create/update customer model |
| 128 | +* `getCustomer` - Get customer |
| 129 | +* `getCustomerAttachment` - Get customer attachment |
| 130 | +* `getCustomerAttachments` - List customer attachments |
| 131 | +* `getCustomers` - List customers |
| 132 | +* `updateCustomer` - Update customer |
| 133 | + |
| 134 | +### directCosts |
| 135 | + |
| 136 | +* `createDirectCost` - Create direct cost |
| 137 | +* `downloadDirectCostAttachment` - Download direct cost attachment |
| 138 | +* `getCreateDirectCostsModel` - Get create direct cost model |
| 139 | +* `getDirectCost` - Get direct cost |
| 140 | +* `getDirectCostAttachment` - Get direct cost attachment |
| 141 | +* `getDirectCosts` - List direct costs |
| 142 | +* `listDirectCostAttachments` - List direct cost attachments |
| 143 | +* `postDirectCostAttachment` - Create direct cost attachment |
| 144 | + |
| 145 | +### directIncomes |
| 146 | + |
| 147 | +* `createDirectIncome` - Create direct income |
| 148 | +* `downloadDirectIncomeAttachment` - Download direct income attachment |
| 149 | +* `getCreateDirectIncomesModel` - Get create direct income model |
| 150 | +* `getDirectIncome` - Get direct income |
| 151 | +* `getDirectIncomeAttachment` - Get direct income attachment |
| 152 | +* `getDirectIncomes` - Get direct incomes |
| 153 | +* `listDirectIncomeAttachments` - List direct income attachments |
| 154 | +* `postDirectIncomeAttachment` - Create direct income attachment |
| 155 | + |
| 156 | +### financials |
| 157 | + |
| 158 | +* `getBalanceSheet` - Get balance sheet |
| 159 | +* `getCashFlowStatement` - Get cash flow statement |
| 160 | +* `getProfitAndLoss` - Get profit and loss |
| 161 | + |
| 162 | +### invoices |
| 163 | + |
| 164 | +* `createInvoice` - Create invoice |
| 165 | +* `donwloadInvoiceAttachment` - Download invoice attachment |
| 166 | +* `getCreateUpdateInvoicesModel` - Get create/update invoice model |
| 167 | +* `getInvoice` - Get invoice |
| 168 | +* `getInvoiceAttachment` - Get invoice attachment |
| 169 | +* `getInvoiceAttachments` - Get invoice attachments |
| 170 | +* `getInvoicePdf` - Get invoice as PDF |
| 171 | +* `listInvoices` - List invoices |
| 172 | +* `pushInvoiceAttachment` - Push invoice attachment |
| 173 | +* `updateInvoice` - Update invoice |
| 174 | + |
| 175 | +### items |
| 176 | + |
| 177 | +* `createItem` - Create item |
| 178 | +* `getCreateItemsModel` - Get create item model |
| 179 | +* `getItem` - Get item |
| 180 | +* `listItems` - List items |
| 181 | + |
| 182 | +### journalEntries |
| 183 | + |
| 184 | +* `createJournalEntry` - Create journal entry |
| 185 | +* `getCreateJournalEntriesModel` - Get create journal entry model |
| 186 | +* `getJournalEntry` - Get journal entry |
| 187 | +* `listJournalEntries` - List journal entries |
| 188 | + |
| 189 | +### journals |
| 190 | + |
| 191 | +* `getCreateJournalsModel` - Get create journal model |
| 192 | +* `getJournal` - Get journal |
| 193 | +* `listJournals` - List journals |
| 194 | +* `pushJournal` - Create journal |
| 195 | + |
| 196 | +### paymentMethods |
| 197 | + |
| 198 | +* `getPaymentMethod` - Get payment method |
| 199 | +* `listPaymentMethods` - List all payment methods |
| 200 | + |
| 201 | +### payments |
| 202 | + |
| 203 | +* `createPayment` - Create payment |
| 204 | +* `getCreatePaymentsModel` - Get create payment model |
| 205 | +* `getPayment` - Get payment |
| 206 | +* `listPayments` - List payments |
| 207 | + |
| 208 | +### purchaseOrders |
| 209 | + |
| 210 | +* `createPurchaseOrder` - Create purchase order |
| 211 | +* `getCreateUpdatePurchaseOrdersModel` - Get create/update purchase order model |
| 212 | +* `getPurchaseOrder` - Get purchase order |
| 213 | +* `listPurchaseOrders` - List purchase orders |
| 214 | +* `updatePurchaseOrder` - Update purchase order |
| 215 | + |
| 216 | +### reports |
| 217 | + |
| 218 | +* `getAgedCreditorsReport` - Aged creditors report |
| 219 | +* `getAgedDebtorsReport` - Aged debtors report |
| 220 | +* `isAgedCreditorsReportAvailable` - Aged creditors report available |
| 221 | +* `isAgedDebtorReportAvailable` - Aged debtors report available |
| 222 | + |
| 223 | +### salesOrders |
| 224 | + |
| 225 | +* `getSalesOrder` - Get sales order |
| 226 | +* `listSalesOrders` - List sales orders |
| 227 | + |
| 228 | +### suppliers |
| 229 | + |
| 230 | +* `createSuppliers` - Create suppliers |
| 231 | +* `downloadSupplierAttachment` - Download supplier attachment |
| 232 | +* `getCreateUpdateSuppliersModel` - Get create/update supplier model |
| 233 | +* `getSupplier` - Get supplier |
| 234 | +* `getSupplierAttachment` - Get supplier attachment |
| 235 | +* `listSupplierAttachments` - List supplier attachments |
| 236 | +* `listSuppliers` - List suppliers |
| 237 | +* `putSupplier` - Update supplier |
| 238 | + |
| 239 | +### taxRates |
| 240 | + |
| 241 | +* `getTaxRate` - Get tax rate |
| 242 | +* `listTaxRates` - List all tax rates |
| 243 | + |
| 244 | +### trackingCategories |
| 245 | + |
| 246 | +* `getTrackingCategory` - Get tracking categories |
| 247 | +* `listTrackingCategories` - List tracking categories |
| 248 | + |
| 249 | +### transfers |
| 250 | + |
| 251 | +* `createTransfer` - Create transfer |
| 252 | +* `getCreateTransfersModel` - Get create transfer model |
| 253 | +* `getTransfer` - Get transfer |
| 254 | +* `listTransfers` - List transfers |
| 255 | +<!-- End SDK Available Operations --> |
| 256 | + |
| 257 | +### SDK Generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks) |
0 commit comments