Categorygithub.com/codatio/client-sdk-go/previous-versions/sync-for-commerce-version-1pkgmodelsshared
# 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
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
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
No description provided by the author
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
AccountingAccountValidDataTypeLinks - When querying Codat's data model, some data types return `validDatatypeLinks` metadata in the JSON response.
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.
No description provided by the author
AccountingCompanyDataset - > 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
AccountingCreateAccountResponseAccountingAccount - > **Language tip:** Accounts are also referred to as **chart of accounts**, **nominal accounts**, and **general ledger**.
No description provided by the author
AccountingCreateAccountResponseValidDataTypeLinks - When querying Codat's data model, some data types return `validDatatypeLinks` metadata in the JSON response.
No description provided by the author
AccountingCreateCreditNoteResponseAccountingCreditNote - > 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
AccountingCreateCustomerResponseAccountingCustomer - > 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
AccountingCreateDirectIncomeResponseAccountingDirectIncome - > **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
AccountingCreateInvoiceResponseAccountingInvoice - > **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
No description provided by the author
No description provided by the author
No description provided by the author
AccountingCreateJournalEntryResponseAccountingJournalEntry - > **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>.
AccountingCreateJournalEntryResponseJournalReference - Links journal entries to the relevant journal in accounting integrations that use multi-book accounting (multiple journals).
No description provided by the author
AccountingCreatePaymentResponseAccountingPayment - > **Payments or bill payments?** > > In Codat, payments represent accounts receivable only.
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
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.
No description provided by the author
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
No description provided by the author
No description provided by the author
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
No description provided by the author
BrandingButton - Button branding references.
No description provided by the author
BrandingLogo - Logo branding references.
No description provided by the author
CommerceCompanyInfo - In the Codat system, company profile includes standard commercial details about a linked company, such as their address, phone number, and company registration.
CommerceCustomer - When a customer places an order with the connected commerce store their details are added to the Customers dataset.
CommerceCustomerRef - Reference to the customer that placed the order.
No description provided by the author
CommerceLocation - The Location datatype holds information on the geographic location at which stocks of products may be held, as referenced in the Products data type.
No description provided by the author
CommerceOrder - Orders contain the transaction details for all products sold by the company, and include details of any payments, service charges, or refunds related to each order.
No description provided by the author
CommercePayment - Payments contain details of all payments made by customers to a company, including: amounts, currency used, payment method, payment provider, and payment status.
CommercePaymentMethod - A Payment Method represents the payment method(s) used to make payments.
No description provided by the author
No description provided by the author
CommerceProduct - A Product is an item in the company's inventory, and includes information about the price and quantity of all products, and variants thereof, available for sale.
No description provided by the author
CommerceTransaction - Details of all financial transactions recorded in the commerce or point of sale system are added to the Transactions data type.
No description provided by the author
No description provided by the author
Company - In Codat, a company represents a business sharing access to their data.
ConfigAccount - G/L account object for configuration.
No description provided by the author
Connection - A connection represents a [company's](https://docs.codat.io/sync-for-commerce-v1-api#/schemas/Company) connection to a data source and allows you to synchronize data (pull and/or push) with that source.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
CreditNoteLineItemRecordReference - Links the current record to the underlying record or data type that created it.
CreditNoteLineItemTracking - Categories, and a project and customer, against which the item is tracked.
No description provided by the author
No description provided by the author
No description provided by the author
DataStatus - Describes the state of data in the Codat cache for a company and data type.
DataTypeFeature - Describes support for a given datatype and associated operations.
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
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ImageReference - Image reference.
Integration - An integration that Codat supports.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ItemRef - Reference to the product, service type, or inventory item to which the direct cost is linked.
ItemReference - Reference to the product, service type, or inventory item to which the direct cost is linked.
No description provided by the author
No description provided by the author
JournalEntryRecordRef - Links a journal entry to the underlying record that created it.
No description provided by the author
JournalLineTracking - List of record refs associated with the tracking information for the line (eg to a Tracking Category, or customer etc.).
JournalReference - 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
LocationRef - Reference to the geographic location where the order was placed.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
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
ProductInventory - Information about the total inventory as well as the locations inventory is in.
No description provided by the author
No description provided by the author
ProductRef - Reference that links the line item to the correct product details.
ProductVariant - Represents a variation of a product available for sale, for example an item of clothing that may be available for sale in multiple sizes and colors.
ProductVariantRef - Reference that links the line item to the specific version of product that has been ordered.
PullOperation - Information about a queued, in progress or completed pull operation.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
RecordReference - Links the current record to the underlying record or data type that created it.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ServiceChargeTaxComponentRef - Taxes rates reference object depending on the rates being available on source commerce software.
SupplementalData - Supplemental data is additional data you can include in our standard data types.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Tags - A collection of user-defined key-value pairs that store custom metadata against the company.
No description provided by the author
TaxComponentRef - Taxes rates reference object depending on the rates being available on source commerce software.
No description provided by the author
No description provided by the author
No description provided by the author
TaxRateRef - Reference to the tax rate to which the line item is linked.
TaxRateReference - Reference to the tax rate to which the line item is linked.
Tracking - Categories, and a project and customer, against which the item is tracked.
TrackingCategoryRefItems - References a category against which the item is tracked.
TrackingCategoryRefs - References a category against which the item is tracked.
TrackingRecordRef - Links to the customer or tracking category.
No description provided by the author
No description provided by the author
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.
No description provided by the author
Weblink associated with the company.
WebLinkItems - Weblink associated with the company.
No description provided by the author
No description provided by the author
# Type aliases
AccountingAddressType - The type of the address.
AccountingCompanyDatasetType - The type of the weblink.
AccountingCreateInvoiceResponseDataType - The underlying data type associated to the reference `id`.
AccountingInvoiceDataType - The underlying data type associated to the reference `id`.
AccountStatus - Status of the account.
AccountType - Type of account.
BankAccountStatus - Status of the bank account.
BankAccountType - The type of transactions and balances on the account.
BilledToType - Defines if the bill or bill credit note is billed/rebilled to a project.
CommerceAddressType - The type of the address.
ContactRefDataType - Allowed name of the 'dataType'.
CreditNoteStatus - Current state of the credit note.
CustomerStatus - Status of customer.
DataConnectionStatus - The current authorization status of the data connection.
DatasetStatus - The current status of the dataset.
DataType - Available data types.
DataTypes - Available data types.
ErrorStatus - The current status of a transient error.
FeatureState - The current release state of the feature.
FeatureType - The type of feature.
InvoiceStatus - Current state of the invoice:
- `Draft` - Invoice hasn't been submitted to the supplier.
JournalEntryRecordRefDataType - Name of underlying data type.
JournalLineDataType - Allowed name of the 'dataType'.
No description provided by the author
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.
PaymentStatus - Status of the payment.
PaymentType - Type of payment.
PhoneNumberType - The type of phone number.
ProductVariantStatus - The status of the product variant.
PushChangeType - Type of change being applied to record in third party platform.
PushOperationStatus - The current status of the push operation.
SchemaDataType - Available data types.
ServiceChargeType - The type of the service charge.
SourceType - The type of platform of the connection.
Status of the Payment Method.
TrackingRecordRefDataType - Name of underlying data type.
TransactionSourceType - The type of source the transaction arose.
TransactionType - The type of the platform transaction: - `Unknown` - `FailedPayout` — Failed transfer of funds from the seller's merchant account to their bank account.
Type - The type of the weblink.