package
0.32.1
Repository: https://github.com/codatio/client-sdk-go.git
Documentation: pkg.go.dev

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

Account - > **Language tip:** Accounts are also referred to as **chart of accounts**, **nominal accounts**, and **general ledger**.
AccountingAccount - > **Language tip:** Accounts are also referred to as **chart of accounts**, **nominal accounts**, and **general ledger**.
No description provided by the author
No description provided by the author
AccountingBankAccount - > **Accessing Bank Accounts through Banking API** > > This datatype was originally used for accessing bank account data both in accounting integrations and open banking aggregators.
AccountingBankAccountTransaction - > **Accessing Bank Accounts through Banking API** > > This datatype was originally used for accessing bank account data both in accounting integrations and open banking aggregators.
AccountingBill - > **Invoices or bills?** > > We distinguish between invoices where the company *owes money* vs.
AccountingBillCreditNote - > **Bill credit notes or credit notes?** > > In Codat, bill credit notes represent accounts payable only.
AccountingBillPayment - > **Bill payments or payments?** > > We distinguish between transactions where the company received money vs.
AccountingCreateBankAccountTransactions Deprecated type: This will be removed in a future release, please migrate away from it as soon as possible.
AccountingCreditNote - > View the coverage for credit notes in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=creditNotes" target="_blank">Data coverage explorer</a>.
AccountingCustomer - > View the coverage for customers in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers" target="_blank">Data coverage explorer</a>.
No description provided by the author
AccountingDirectCost - > **Language tip:** Direct costs may also be referred to as **Spend transactions**, **Spend money transactions**, or **Payments** in various accounting software.
AccountingDirectIncome - > **Language tip:** Direct incomes may also be referred to as **Receive transactions**, **Receive money transactions**, **Sales receipts**, or **Cash sales** in various accounting software.
AccountingInvoice - > **Invoices or bills?** > > We distinguish between invoices where the company *owes money* vs.
AccountingItem - > View the coverage for items in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=items" target="_blank">Data coverage explorer</a>.
AccountingJournal - > **Language tip:** For line items, or individual transactions, of a company's financial documents, refer to the [Journal entries](https://docs.codat.io/accounting-api#/schemas/JournalEntry) data type > View the coverage for journals in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=journals" target="_blank">Data coverage explorer</a>.
AccountingJournalEntry - > **Language tip:** For the top-level record of a company's financial transactions, refer to the [Journals](https://docs.codat.io/accounting-api#/schemas/Journal) data type > View the coverage for journal entries in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=journalEntries" target="_blank">Data coverage explorer</a>.
AccountingPayment - > **Payments or bill payments?** > > In Codat, payments represent accounts receivable only.
No description provided by the author
AccountingPurchaseOrder - > View the coverage for purchase orders in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=purchaseOrders" target="_blank">Data coverage explorer</a>.
AccountingSupplier - > View the coverage for suppliers in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers" target="_blank">Data coverage explorer</a>.
AccountingTransfer - > View the coverage for transfers in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=transfers" target="_blank">Data coverage explorer</a>.
No description provided by the author
AccountRef - Data types that reference an account, for example bill and invoice line items, use an accountRef that includes the ID and name of the linked account.
No description provided by the author
AccountTransaction - > **Language tip:** In Codat, account transactions represent all transactions posted to a bank account within an accounting software.
No description provided by the author
AccountTransactionLineRecordRef - Links an account transaction line to the underlying record that created it.
No description provided by the author
No description provided by the author
AgedCreditorReport - The Aged Creditors report shows the total balance owed by a business to its suppliers over time.
No description provided by the author
No description provided by the author
AgedDebtorReport - The Aged Debtors report shows the total outstanding balance due from customers to the business over time.
No description provided by the author
No description provided by the author
No description provided by the author
Attachment - The Codat API supports pulling and pushing of file attachments for invoices, bills, direct costs, and direct incomes.
No description provided by the author
No description provided by the author
No description provided by the author
BalanceSheetInput - > View the coverage for balance sheet in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=balanceSheet" target="_blank">Data coverage explorer</a>.
BankAccount - > **Accessing Bank Accounts through Banking API** > > This datatype was originally used for accessing bank account data both in accounting integrations and open banking aggregators.
BankAccountRef - Links to the Account transactions data type.
No description provided by the author
No description provided by the author
Bill - > **Invoices or bills?** > > We distinguish between invoices where the company *owes money* vs.
BillCreditNote - > **Bill credit notes or credit notes?** > > In Codat, bill credit notes represent accounts payable only.
No description provided by the author
BillCreditNoteLineItemTracking - Categories, and a project and customer, against which the item is tracked.
No description provided by the author
BillItem - Item details that are only for bills.
No description provided by the author
BillPayment - > **Bill payments or payments?** > > We distinguish between transactions where the company received money vs.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
CashFlowStatementInput - > View the coverage for cash flow statement in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=cashFlowStatement" target="_blank">Data coverage explorer</a>.
No description provided by the author
CompanyDataset - > View the coverage for company profile in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=cashFlowStatement" target="_blank">Data coverage explorer</a>.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
CreatePurchaseOrderResponseUser - The user who created the purchase order in the accounting system.
No description provided by the author
No description provided by the author
CreditNote - > View the coverage for credit notes in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=creditNotes" target="_blank">Data coverage explorer</a>.
No description provided by the author
CreditNoteLineItemTracking - Categories, and a project and customer, against which the item is tracked.
No description provided by the author
Customer - > View the coverage for customers in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers" target="_blank">Data coverage explorer</a>.
No description provided by the author
No description provided by the author
DirectCost - > **Language tip:** Direct costs may also be referred to as **Spend transactions**, **Spend money transactions**, or **Payments** in various accounting software.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DirectIncome - > **Language tip:** Direct incomes may also be referred to as **Receive transactions**, **Receive money transactions**, **Sales receipts**, or **Cash sales** in various accounting software.
No description provided by the author
No description provided by the author
ErrorValidation - A human-readable object describing validation decisions Codat has made.
No description provided by the author
No description provided by the author
Invoice - > **Invoices or bills?** > > We distinguish between invoices where the company *owes money* vs.
InvoiceItem - Item details that are only for bills.
No description provided by the author
No description provided by the author
InvoiceTo - Links the current record to the underlying record or data type that created it.
Item - > View the coverage for items in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=items" target="_blank">Data coverage explorer</a>.
ItemReceipt - An item receipt records the receipt of items into a SMBs inventory.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Journal - > **Language tip:** For line items, or individual transactions, of a company's financial documents, refer to the [Journal entries](https://docs.codat.io/accounting-api#/schemas/JournalEntry) data type > View the coverage for journals in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=journals" target="_blank">Data coverage explorer</a>.
No description provided by the author
JournalEntry - > **Language tip:** For the top-level record of a company's financial transactions, refer to the [Journals](https://docs.codat.io/accounting-api#/schemas/Journal) data type > View the coverage for journal entries in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=journalEntries" target="_blank">Data coverage explorer</a>.
JournalEntryRecordRef - Links a journal entry to the underlying record that created it.
No description provided by the author
No description provided by the author
JournalRef - Links journal entries to the relevant journal in accounting integrations that use multi-book accounting (multiple journals).
No description provided by the author
No description provided by the author
No description provided by the author
Payment - > **Payments or bill payments?** > > In Codat, payments represent accounts receivable only.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PaymentMethod - > View the coverage for payment methods in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=paymentMethods" target="_blank">Data coverage explorer</a>.
PaymentMethodRef - The payment method the record is linked to in the accounting or commerce software.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ProfitAndLossReportInput - > **Language tip:** Profit and loss statement is also referred to as **income statement** under US GAAP (Generally Accepted Accounting Principles).
No description provided by the author
PropertieTracking - Categories, and a project and customer, against which the item is tracked.
PropertieTracking1 - Categories, and a project and customer, against which the item is tracked.
No description provided by the author
PurchaseOrder - > View the coverage for purchase orders in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=purchaseOrders" target="_blank">Data coverage explorer</a>.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
RecordLineReference - Reference to the item receipt line this line was generated from.
RecordReference - Links the current record to the underlying record or data type that created it.
No description provided by the author
SalesOrder - > View the coverage for sales orders in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=salesOrders" target="_blank">Data coverage explorer</a>.
SalesOrderContact - Details of the named contact at the delivery address.
No description provided by the author
No description provided by the author
No description provided by the author
SalesOrderShipTo - Delivery details for any goods that have been ordered.
No description provided by the author
No description provided by the author
ShipTo - Delivery details for any goods that have been ordered.
ShipToContact - Details of the named contact at the delivery address.
SupplementalData - Supplemental data is additional data you can include in our standard data types.
Supplier - > View the coverage for suppliers in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers" target="_blank">Data coverage explorer</a>.
SupplierRef - Reference to the supplier the record relates to.
No description provided by the author
TaxRate - > View the coverage for tax rates in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=taxRates" target="_blank">Data coverage explorer</a>.
TaxRateComponent - A tax rate can be made up of multiple sub taxes, often called components of the tax.
TaxRateRef - Data types that reference a tax rate, for example invoice and bill line items, use a taxRateRef that includes the ID and name of the linked tax rate.
No description provided by the author
No description provided by the author
No description provided by the author
TrackingCategory - Details of a category used for tracking transactions.
TrackingCategoryRef - References a category against which the item is tracked.
TrackingCategoryTree - The full structure of a specific tracking category including any child or subcategories.
TrackingRecordRef - Links to the customer or tracking category.
Transfer - > View the coverage for transfers in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=transfers" target="_blank">Data coverage explorer</a>.
TransferAccount - Account details of the account sending or receiving the transfer.
No description provided by the author
No description provided by the author
UpdateBankAccountResponseAccountingBankAccount - > **Accessing Bank Accounts through Banking API** > > This datatype was originally used for accessing bank account data both in accounting integrations and open banking aggregators.
No description provided by the author
UpdateBillCreditNoteResponseAccountingBillCreditNote - > **Bill credit notes or credit notes?** > > In Codat, bill credit notes represent accounts payable only.
No description provided by the author
UpdateBillResponseAccountingBill - > **Invoices or bills?** > > We distinguish between invoices where the company *owes money* vs.
No description provided by the author
No description provided by the author
UpdateCreditNoteResponseAccountingCreditNote - > View the coverage for credit notes in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=creditNotes" target="_blank">Data coverage explorer</a>.
No description provided by the author
UpdateCustomerResponseAccountingCustomer - > View the coverage for customers in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers" target="_blank">Data coverage explorer</a>.
No description provided by the author
UpdateInvoiceResponseAccountingInvoice - > **Invoices or bills?** > > We distinguish between invoices where the company *owes money* vs.
No description provided by the author
UpdatePurchaseOrderResponseAccountingPurchaseOrder - > View the coverage for purchase orders in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=purchaseOrders" target="_blank">Data coverage explorer</a>.
UpdatePurchaseOrderResponseUser - The user who created the purchase order in the accounting system.
No description provided by the author
UpdateSupplierResponseAccountingSupplier - > View the coverage for suppliers in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers" target="_blank">Data coverage explorer</a>.
User - The user who created the purchase order in the accounting system.
Validation - A human-readable object describing validation decisions Codat has made when pushing data into the platform.
No description provided by the author
ValidDataTypeLinks - When querying Codat's data model, some data types return `validDatatypeLinks` metadata in the JSON response.
Weblink associated with the company.
No description provided by the author
No description provided by the author
Zero - Links the current record line to the underlying record line that created it.

# Type aliases

AccountingAddressType - The type of the address.
AccountStatus - Status of the account.
AccountTransactionLineRecordRefDataType - Name of underlying data type.
AccountTransactionStatus - The status of the account transaction.
AccountType - Type of account.
BankAccountStatus - Status of the bank account.
BankAccountType - The type of transactions and balances on the account.
BankTransactionType - Type of transaction for the bank statement line.
BillCreditNoteStatus - Current state of the bill credit note.
BilledToType - Defines if the invoice or credit note is billed/rebilled to a project or customer.
BilledToType1 - Defines if the bill or bill credit note is billed/rebilled to a project.
BillPaymentLineLinkType - Types of links to bill payment lines.
BillStatus - Current state of the bill.
ContactRefDataType - Allowed name of the 'dataType'.
CreateBankAccountResponseBankAccountType - The type of transactions and balances on the account.
CreditNoteStatus - Current state of the credit note.
CustomerStatus - Status of customer.
DatasetStatus - The current status of the dataset.
DataType - Available data types.
InvoiceStatus - Current state of the invoice: - `Draft` - Invoice hasn't been submitted to the supplier.
ItemReceiptLineItemDataType - Allowed name of the 'dataType'.
ItemReceiptStatus - Current status of the item receipt.
ItemStatus - Current state of the item, either: - `Active`: Available for use - `Archived`: Unavailable - `Unknown` Due to a [limitation in Xero's API](https://docs.codat.io/integrations/accounting/xero/xero-faq#why-do-all-of-my-items-from-xero-have-their-status-as-unknown), all items from Xero are mapped as `Unknown`.
ItemType - Type of the item.
JournalEntryRecordRefDataType - Name of underlying data type.
JournalLineDataType - Allowed name of the 'dataType'.
JournalStatus - Current journal status.
PaymentLinkType - Types of payment line links, either: `Unknown` `Unlinked` - Not used `Invoice` - ID refers to the invoice `CreditNote` - ID refers to the credit note `Refund` - ID refers to the sibling payment `Payment` - ID refers to the sibling payment `PaymentOnAccount` - ID refers to the customer `Other` - ID refers to the customer `Manual Journal` `Discount` - ID refers to the payment.
PaymentMethodStatus - Status of the Payment Method.
PaymentMethodType - Method of payment.
PhoneNumberType - The type of phone number.
PurchaseOrderStatus - Current state of the purchase order.
PushChangeType - Type of change being applied to record in third party platform.
PushOperationStatus - The current status of the push operation.
PushOptionType - The option type.
ReportBasis - Accounting method used when aggregating the report data.
ReportInput - Accounting method used to prepare the cash flow statement.
SalesOrderInvoiceStatus - If the sales order is converted to an invoice, or will be in future, the invoicingStatus field indicates the current stage of the invoicing process.
SalesOrderRefDataType - The underlying data type associated to the reference `id`.
SalesOrderStatus - Current state of the sales order.
Status - Current state of the tracking category.
SupplierStatus - Status of the supplier.
TaxRateStatus - Status of the tax rate in the accounting software.
TrackingRecordRefDataType - Name of underlying data type.
Type - The type of the weblink.
UpdateBankAccountResponseBankAccountType - The type of transactions and balances on the account.
ZeroDataType - Allowed name of the 'dataType'.