@codat/accounting

Accounting API

Codat's Accounting API is a flexible API for pulling and pushing up-to-date accounting data to your customer's accounting software. It gives you a simple way to view, create, update adn delete data without having to worry about each platform's specific complexities.

SDK Installation

NPM

npm add @codat/accounting

Yarn

yarn add @codat/accounting

SDK Example Usage

import { CodatAccounting } from "@codat/accounting";
import { GetAccountTransactionResponse } from "@codat/accounting/dist/sdk/models/operations";
import { AccountTransactionStatus } from "@codat/accounting/dist/sdk/models/shared";

const sdk = new CodatAccounting({
  security: {
    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
  },
});

sdk.accountTransactions.get({
  accountTransactionId: "corrupti",
  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
}).then((res: GetAccountTransactionResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});

Available Resources and Operations

accountTransactions

• get - Get account transaction
• list - List account transactions

accounts

• create - Create account
• get - Get account
• getCreateModel - Get create account model
• list - List accounts

bankAccountTransactions

• create - Create bank transactions
• getCreateModel - List push options for bank account bank transactions
• list - List bank transactions for bank account

bankAccounts

• create - Create bank account
• get - Get bank account :warning: Deprecated
• getCreateUpdateModel - Get create/update bank account model
• list - List bank accounts
• update - Update bank account

billCreditNotes

• create - Create bill credit note
• get - Get bill credit note
• getCreateUpdateModel - Get create/update bill credit note model
• list - List bill credit notes
• update - Update bill credit note

billPayments

• create - Create bill payments
• delete - Delete bill payment
• get - Get bill payment
• getCreateModel - Get create bill payment model
• list - List bill payments

bills

• create - Create bill
• delete - Delete bill
• downloadAttachment - Download bill attachment
• get - Get bill
• getAttachment - Get bill attachment
• getCreateUpdateModel - Get create/update bill model
• list - List bills
• listAttachments - List bill attachments
• update - Update bill
• uploadAttachment - Upload bill attachment

companyInfo

• get - Get company info
• refresh - Refresh company info

creditNotes

• create - Create credit note
• get - Get credit note
• getCreateUpdateModel - Get create/update credit note model
• list - List credit notes
• update - Update creditNote

customers

• create - Create customer
• downloadAttachment - Download customer attachment
• get - Get customer
• getAttachment - Get customer attachment
• getCreateUpdateModel - Get create/update customer model
• list - List customers
• listAttachments - List customer attachments
• update - Update customer

directCosts

• create - Create direct cost
• downloadAttachment - Download direct cost attachment
• get - Get direct cost
• getAttachment - Get direct cost attachment
• getCreateModel - Get create direct cost model
• list - List direct costs
• listAttachments - List direct cost attachments
• uploadAttachment - Upload direct cost attachment

directIncomes

• create - Create direct income
• downloadAttachment - Download direct income attachment
• get - Get direct income
• getAttachment - Get direct income attachment
• getCreateModel - Get create direct income model
• list - List direct incomes
• listAttachments - List direct income attachments
• uploadAttachment - Create direct income attachment

invoices

• create - Create invoice
• delete - Delete invoice
• downloadAttachment - Download invoice attachment
• downloadPdf - Get invoice as PDF
• get - Get invoice
• getAttachment - Get invoice attachment
• getCreateUpdateModel - Get create/update invoice model
• list - List invoices
• listAttachments - List invoice attachments
• update - Update invoice
• uploadAttachment - Push invoice attachment

items

• create - Create item
• get - Get item
• getCreateModel - Get create item model
• list - List items

journalEntries

• create - Create journal entry
• delete - Delete journal entry
• get - Get journal entry
• getCreateModel - Get create journal entry model
• list - List journal entries

journals

• create - Create journal
• get - Get journal
• getCreateModel - Get create journal model
• list - List journals

paymentMethods

• get - Get payment method
• list - List all payment methods

payments

• create - Create payment
• get - Get payment
• getCreateModel - Get create payment model
• list - List payments

purchaseOrders

• create - Create purchase order
• get - Get purchase order
• getCreateUpdateModel - Get create/update purchase order model
• list - List purchase orders
• update - Update purchase order

reports

• getAgedCreditorsReport - Aged creditors report
• getAgedDebtorsReport - Aged debtors report
• getBalanceSheet - Get balance sheet
• getCashFlowStatement - Get cash flow statement
• getProfitAndLoss - Get profit and loss
• isAgedCreditorsReportAvailable - Aged creditors report available
• isAgedDebtorReportAvailable - Aged debtors report available

salesOrders

• get - Get sales order
• list - List sales orders

suppliers

• create - Create supplier
• downloadAttachment - Download supplier attachment
• get - Get supplier
• getAttachment - Get supplier attachment
• getCreateUpdateModel - Get create/update supplier model
• list - List suppliers
• listAttachments - List supplier attachments
• update - Update supplier

taxRates

• get - Get tax rate
• list - List all tax rates

trackingCategories

• get - Get tracking categories
• list - List tracking categories

transfers

• create - Create transfer
• get - Get transfer
• getCreateModel - Get create transfer model
• list - List transfers

SDK Generated by Speakeasy