Objects

Every object the API sends and takes, field by field.

Account

Everything in AccountCreate, and:

FieldTypeAbout
id requiredstring
is_active requiredboolean
is_system requiredboolean

Accounts SYNC relies on, such as card clearing. They can be renamed, not deactivated.

intercompanyboolean

Holds balances with other companies in the same group. Combined reports eliminate it.

AccountCreate

FieldTypeAbout
code requiredstring

Up to 20 characters.

name requiredstring

Up to 200 characters.

plain_namestring

Plain-English label shown to owners, for example "Money you owe suppliers".

Up to 200 characters.

type requiredAccountType
subtypestring

Up to 50 characters.

parent_idstring
cash_flow_class requiredCashFlowClass
tax_linestring

Line on the entity's return this account maps to.

descriptionstring

Up to 1000 characters.

AccountType

One of: asset, liability, equity, income, cost_of_goods_sold, expense, other_income, other_expense.

AccountUpdate

FieldTypeAbout
namestring

Up to 200 characters.

plain_namestring

Up to 200 characters.

subtypestring

Up to 50 characters.

parent_idstring
cash_flow_classCashFlowClass
tax_linestring
descriptionstring

Up to 1000 characters.

is_activeboolean
intercompanyboolean

Holds balances with other companies in the same group. Combined reports eliminate it.

Amount

Decimal amount as a string, up to 4 decimal places.

Type: string

ApprovalRequest

FieldTypeAbout
id requiredstring (uuid)
agent_id requiredstring (uuid)
action requiredstring

One of: bank_line, bill, bill_payment, invoice, expense, vendor.

summary requiredstring

What it is, e.g. "Bill 1042 from Acme Supply, $2,000.00".

amountstring

Present when it has an amount.

reason requiredstring

Why it waits for a person.

status requiredstring

One of: pending, approved, rejected.

created_at requiredstring (date-time)
decided_atstring (date-time)
decision_notestring

BankAccount

FieldTypeAbout
id requiredstring
account_id requiredstring

The ledger account this bank account posts to.

name requiredstring
institutionstring
maskstring

Last four digits only.

kind requiredstring

One of: checking, savings, credit_card, loan, other.

source requiredstring

One of: stripe, statements, manual.

feed_status requiredstring

One of: active, needs_login, stale, disconnected, not_applicable.

last_synced_atstring (date-time)
reconciled_throughstring (date)
feed_start_onstring (date)
ownership_statusstring

One of: pending, matched, mismatch, unavailable, confirmed, null.

ownership_nameslist of string

BankTransaction

FieldTypeAbout
id requiredstring
bank_account_id requiredstring
date requiredstring (date)
amount requiredAmount

Positive is money in, negative is money out.

description requiredstring
check_numberstring
status requiredBankTransactionStatus
sources requiredlist of string

Every feed or statement this line was seen in, after de-duplication.

suggestionobject
duplicate_ofstring
journal_entry_idstring

BankTransactionApproval

FieldTypeAbout
match_journal_entry_idstring

Match to an existing entry instead of posting a new one.

splitslist of object

Override the suggestion. Amounts must sum to the bank line.

save_as_ruleboolean

Default: false.

BankTransactionStatus

One of: unreviewed, suggested, matched, posted, excluded, duplicate.

BillEvent

Everything in EventCommon, and:

FieldTypeAbout
action requiredstring

One of: record, void.

bill_number requiredstring
vendor_external_id requiredstring
purchase_order_numberstring
due_onstring (date)
lineslist of DocumentLine

Required when recording.

taxeslist of TaxLine
freightNonNegativeAmount

Allocated into the cost of inventory lines (landed cost).

totalAmount

BillPaymentEvent

Everything in EventCommon, and:

FieldTypeAbout
vendor_external_id requiredstring
amount requiredNonNegativeAmount
method requiredstring

One of: ach, check, card, wire, cash, other.

bank_account_idstring
check_numberstring
paid_from_account_idstring (uuid)

The cash account the money came from, when it isn't the default for the method.

applied_to requiredlist of object

CashFlowClass

One of: cash, operating, investing, financing.

Code

Type: string

CombinedReport

A report's shape, with a column for each company keyed by its entity id, then eliminations when eliminated, then total (or debit and credit on the trial balance). Account lines carry accounts, each company's own account id for that line, in place of account_id.

Everything in Report, and:

FieldTypeAbout
companies requiredlist of object

The companies combined, the parent first.

left_out requiredobject
eliminated requiredboolean

Whether an Eliminations column removed intercompany amounts.

intercompany_difference requiredAmount

On the balance sheet, how far the companies' intercompany balances don't match, shown in equity as the intercompany difference. 0.00 when they agree.

Connection

FieldTypeAbout
id requiredstring
platform requiredstring

The platform's registered app id, for example payroll_genie.

external_tenant_id requiredstring
entity_idstring

Set once the owner approves.

status requiredConnectionStatus
scopeslist of string
authorize_urlstring (uri)

Present while pending.

activated_atstring (date-time)
disconnected_atstring (date-time)
created_at requiredstring (date-time)

ConnectionCreate

FieldTypeAbout
external_tenant_id requiredstring

The business's id inside the platform.

Up to 255 characters.

display_namestring

Up to 200 characters.

owner_email requiredstring (email)
redirect_url requiredstring (uri)

Where SYNC sends the owner after approving, with connection_id and status added as query parameters. Must be https.

requested_scopeslist of string

ConnectionStatus

One of: pending, active, disconnected.

Contact

Everything in ContactUpsert, and:

FieldTypeAbout
id requiredstring
kind requiredstring

One of: customer, vendor.

balanceAmount

ContactUpsert

FieldTypeAbout
external_id requiredstring

Up to 255 characters.

name requiredstring

Up to 200 characters.

emailstring (email)
phonestring
addressobject
tax_exemptboolean
is_1099boolean

Vendors only.

payment_terms_daysinteger

CreditApplicationEvent

Everything in EventCommon, and:

FieldTypeAbout
credit_note_number requiredstring
customer_external_id requiredstring
applied_to requiredlist of CreditApplied

CreditApplied

FieldTypeAbout
invoice_number requiredstring
amount requiredNonNegativeAmount

CreditNoteEvent

Everything in EventCommon, and:

FieldTypeAbout
action requiredstring

One of: issue, void.

credit_note_number requiredstring
customer_external_id requiredstring
lineslist of DocumentLine

Required when issuing. Positive amounts, taken back from income.

taxeslist of TaxLine

Sales tax given back, by jurisdiction, with the taxable amount credited.

shippingNonNegativeAmount
applied_tolist of CreditApplied

The customer's open invoices this credit settles now. The rest is kept as their credit.

reasonstring

Up to 500 characters.

invoice_numberstring

The invoice the goods on it were sold on, so they come back into stock at what it took out.

restockboolean

Whether inventory items on it come back into stock.

Default: true.

totalAmount

CreditRefundEvent

Everything in EventCommon, and:

FieldTypeAbout
credit_note_number requiredstring
customer_external_id requiredstring
amount requiredNonNegativeAmount
method requiredstring

One of: check, ach, card, cash, wire, other.

processorstring
paid_from_account_idstring (uuid)

The cash account the money came from, when it isn't the default for the method.

Currency

Default: "USD".

Type: string

DailyCloseEvent

Everything in EventCommon, and:

FieldTypeAbout
registerstring
gross_sales requiredAmount
discountsNonNegativeAmount
refundsNonNegativeAmount
sales_by_categorylist of object
items_soldlist of object

Item quantities, so SYNC can deplete stock and post COGS.

taxeslist of TaxLine
tipsNonNegativeAmount
gift_cards_soldNonNegativeAmount
tenders requiredlist of Tender
cash_over_shortAmount

Dimension

FieldTypeAbout
code requiredCode
name requiredstring
values requiredlist of DimensionValue

Dimensions

Dimension code to value code, for example {"location": "maui"}.

Type: object

DimensionValue

FieldTypeAbout
code requiredCode
name requiredstring
is_active requiredboolean

DocumentLine

FieldTypeAbout
item_skustring

An inventory item here moves stock: an invoice takes it out, a bill brings it in. Other or unknown items move nothing.

description requiredstring

Up to 500 characters.

quantityQuantity

Required, and positive, on lines for inventory items.

unit_priceAmount
amount requiredAmount
categorystring

Income category (invoices) or expense category (bills).

account_idstring

Optional explicit account, overriding the category mapping.

taxableboolean

Default: true.

dimensionsDimensions

Entity

FieldTypeAbout
id requiredstring
organization_id requiredstring
legal_name requiredstring
display_namestring
entity_typestring

One of: sole_proprietorship, partnership, llc, s_corp, c_corp, nonprofit, other.

base_currency requiredCurrency
fiscal_year_start_month requiredinteger
accounting_basis requiredstring

One of: accrual, cash.

tax_basisstring

One of: accrual, cash.

timezonestring

Event

FieldTypeAbout
id requiredstring
type requiredEventType
status requiredEventStatus
connection_idstring
external_id requiredstring
occurred_on requiredstring (date)
journal_entry_idstring
review_reasonstring

Why a person must look at it, in plain English.

errorslist of object

Why the event is held. code is mapping_required when a mapping is missing, with path naming it as kind:key (for example revenue_category:retail); otherwise it's the error a re-post hit.

payloadobject

The event body as posted.

created_at requiredstring (date-time)
posted_atstring (date-time)

EventCommon

FieldTypeAbout
external_id requiredstring

The platform's own id for this event. Unique per connection and type.

Up to 255 characters.

occurred_on requiredstring (date)

The business date the event belongs to.

currency requiredCurrency
dimensionsDimensions
memostring

Up to 1000 characters.

sourceSourceRef
metadataobject

EventStatus

received: accepted, not yet posted. posted: journal entry written. needs_review: a person must map something (for example an unknown category) before it posts. failed: rejected; see errors. reversed: its entry was reversed.

One of: received, posted, needs_review, failed, reversed.

EventType

One of: sale, refund, payment_refund, daily_close, payout, invoice, payment_received, bill, bill_payment, payroll_run, inventory_movement.

Import

FieldTypeAbout
id requiredstring
kind requiredstring
status requiredstring

One of: needs_review, tie_out_failed, ready_to_promote, promoted, canceled, reversed.

questionslist of object

Mapping decisions the owner or CPA must make.

tie_outlist of object
created_at requiredstring (date-time)
promoted_atstring (date-time)
reversal_entry_idstring
reversed_atstring (date-time)

InventoryMovementEvent

Everything in EventCommon, and:

FieldTypeAbout
movements requiredlist of object

InvoiceEvent

Everything in EventCommon, and:

FieldTypeAbout
action requiredstring

One of: issue, void.

invoice_number requiredstring
customer_external_id requiredstring
due_onstring (date)
lineslist of DocumentLine

Required when issuing.

taxeslist of TaxLine
shippingNonNegativeAmount
deposit_appliedNonNegativeAmount
totalAmount

Item

Everything in ItemUpsert, and:

FieldTypeAbout
id requiredstring
is_active requiredboolean
quantity_on_handQuantity
average_costAmount

Value on hand over quantity on hand, under either costing method.

low_stock requiredboolean

True while stock is at or under the reorder point.

ItemUpsert

FieldTypeAbout
sku requiredstring

Up to 100 characters.

name requiredstring

Up to 200 characters.

kind requiredstring

One of: inventory, non_inventory, service, bundle.

categorystring
unit_of_measurestring
barcodestring
track_lotsboolean

Default: false.

income_account_idstring
cogs_account_idstring
asset_account_idstring
taxableboolean

False for an item never charged sales tax. Invoices entered in the app leave it out of the taxable amount.

reorder_pointstring

Stock at or under this is low. Owners get one email each time an item becomes low.

reorder_quantitystring

How many to order when the item is low.

is_activeboolean

JournalEntry

FieldTypeAbout
id requiredstring
number requiredstring

Sequential per entity, assigned at posting.

entity_id requiredstring
date requiredstring (date)
memostring
currency requiredCurrency
status requiredstring

One of: posted, reversed.

source_type requiredSourceType
event_idstring
sourceSourceRef
is_adjustingboolean
reversal_ofstring
reversed_bystring
lines requiredlist of JournalLine
created_byobject
created_at requiredstring (date-time)

JournalEntryCreate

FieldTypeAbout
date requiredstring (date)
memostring

Up to 1000 characters.

currencyCurrency
is_adjustingboolean

Marks an accountant's adjusting entry (AJE), reported separately.

Default: false.

lines requiredlist of JournalLine

Each line has a debit or a credit, not both. Debits must equal credits.

JournalLine

FieldTypeAbout
account_id requiredstring
account_codestring
debit requiredNonNegativeAmount
credit requiredNonNegativeAmount
descriptionstring

Up to 500 characters.

dimensionsDimensions
contact_idstring

KpiValue

FieldTypeAbout
kpistring
namestring
unitstring

One of: currency, percent, days, months, count, number.

betterstring
missingboolean
periodstring

One of: this_month, last_month, year_to_date, last_12_months.

start_datestring (date)
end_datestring (date)
valuestring
last_yearstring
notestring
targetstring
on_targetboolean
trendlist of object

ListEnvelope

FieldTypeAbout
data requiredlist of any
has_more requiredboolean

MileageTrip

FieldTypeAbout
idstring (uuid)
datestring (date)
purposestring
milesstring
vehiclestring
start_placestring
end_placestring
projectstring
recordedboolean
journal_entry_idstring (uuid)
rate_centsstring

The IRS business standard mileage rate in force on the trip date, in cents per mile.

rate_confirmedboolean
amountstring

Miles times the rate, to the cent.

NonNegativeAmount

Type: string

PaymentReceivedEvent

Everything in EventCommon, and:

FieldTypeAbout
customer_external_id requiredstring
amount requiredNonNegativeAmount
method requiredstring

One of: card, ach, cash, check, wire, other.

processorstring
processor_payment_idstring
customer_feeNonNegativeAmount
deposit_account_idstring (uuid)

The cash account the money went into, when it isn't the default for the method.

applied_to requiredlist of object

Invoices this payment pays. An unapplied remainder becomes a customer credit.

PaymentRefundEvent

Everything in EventCommon, and:

FieldTypeAbout
original_external_id requiredstring

The external_id of the sale or customer payment refunded.

amount requiredNonNegativeAmount

Everything given back, more than zero.

customer_feeNonNegativeAmount

The part of amount that gives back a fee the customer paid on top.

reasonstring

Up to 500 characters.

PayoutEvent

Everything in EventCommon, and:

FieldTypeAbout
processor requiredstring
payout_id requiredstring
arrival_datestring (date)
bank_account_idstring

The SYNC bank account the deposit lands in, if known.

gross requiredAmount
refundsNonNegativeAmount
chargebacksNonNegativeAmount
fees requiredNonNegativeAmount
reserve_heldNonNegativeAmount
reserve_releasedNonNegativeAmount
spendingNonNegativeAmount

Money spent straight from the processor balance (a PayPal purchase) since the last payout, booked to Uncategorized expense to sort.

adjustmentsAmount
net requiredAmount

Must equal gross minus refunds, chargebacks, fees, reserve held and spending, plus reserve released and adjustments.

itemslist of object

PayrollDeduction

FieldTypeAbout
deduction_type requiredstring
descriptionstring
pre_taxboolean
amount requiredNonNegativeAmount
employer_contributionNonNegativeAmount

PayrollRunEvent

Everything in EventCommon, and:

FieldTypeAbout
pay_date requiredstring (date)
period_start requiredstring (date)
period_end requiredstring (date)
employee_countinteger
gross_wages requiredNonNegativeAmount
officer_wagesNonNegativeAmount

Part of gross wages paid to officers, for tax reporting.

employee_taxes requiredlist of PayrollTax
employer_taxes requiredlist of PayrollTax
deductionslist of PayrollDeduction
reimbursementsNonNegativeAmount
net_pay requiredNonNegativeAmount
funding_debit_onstring (date)

When the employer's account is debited, so the bank line matches.

hoursQuantity

Total hours worked, for labor reports.

splitslist of object

Optional breakdown of wages, employer taxes and hours by dimension.

PayrollTax

FieldTypeAbout
tax_type requiredstring
jurisdiction requiredstring
amount requiredNonNegativeAmount

Period

FieldTypeAbout
id requiredstring
fiscal_year requiredinteger
start_date requiredstring (date)
end_date requiredstring (date)
status requiredstring

One of: open, soft_closed, hard_closed.

closed_atstring (date-time)
closed_bystring

PostingMapping

Everything in PostingMappingUpsert, and:

FieldTypeAbout
account_code requiredstring
account_name requiredstring

PostingMappingKind

One of: role, revenue_category, expense_category, tax_jurisdiction, card_processor, payroll_tax, deduction.

PostingMappingUpsert

FieldTypeAbout
kind requiredPostingMappingKind
key requiredstring

The role name, category, jurisdiction, processor, tax type or deduction type.

Up to 100 characters.

account_id requiredstring

Problem

FieldTypeAbout
type requiredstring (uri)
title requiredstring
status requiredinteger
code requiredstring
detailstring
request_idstring
errorslist of object

Proposal

FieldTypeAbout
id requiredstring (uuid)
kindstring

One of: journal_entry.

status requiredstring

One of: pending, approved, rejected.

reason requiredstring
entry requiredobject
proposed_by_typestring
proposed_by_idstring
created_at requiredstring (date-time)
decided_by_idstring
decided_atstring (date-time)
decision_notestring
journal_entry_idstring

Quantity

Decimal quantity as a string, up to 6 decimal places.

Type: string

Reconciliation

FieldTypeAbout
id requiredstring
bank_account_id requiredstring
as_of requiredstring (date)
status requiredstring

One of: reconciled, difference_found.

book_balance requiredAmount
adjusted_balanceAmount

The book balance less items that haven't cleared.

ending_balance requiredAmount
feed_balanceAmount

Balance reported by the bank feed, when connected.

difference requiredAmount
unclearedlist of object
unreviewedlist of object

Bank lines through this date not yet approved or excluded.

explanationstring

Plain-English account of the difference.

RefundEvent

Everything in EventCommon, and:

FieldTypeAbout
original_external_id requiredstring

The external_id of the sale being refunded.

lineslist of SaleLine

Omit for a full refund.

restockboolean

Default: true.

taxeslist of TaxLine
tipsNonNegativeAmount
reasonstring

Up to 500 characters.

tenders requiredlist of Tender

Report

FieldTypeAbout
report requiredstring
currency requiredCurrency
basisstring

One of: accrual, cash.

parametersobject
generated_at requiredstring (date-time)
columns requiredlist of object
rows requiredlist of ReportRow

ReportRow

FieldTypeAbout
kind requiredstring

One of: section, account, line, subtotal, total.

label requiredstring
account_idstring
values requiredobject

Column key to amount.

rowslist of ReportRow
drilldown_urlstring (uri)

Lists the journal entries behind the numbers.

SaleEvent

Everything in EventCommon, and:

FieldTypeAbout
channelstring

Where the sale was made. marketplace is a sale through a marketplace facilitator (Amazon, Etsy and the like) that collects the sales tax; each state's own rule decides whether it counts toward the business's economic nexus threshold.

One of: counter, online, wholesale, invoice, marketplace, other.

customer_external_idstring
lines requiredlist of SaleLine
order_discountNonNegativeAmount
shippingNonNegativeAmount
taxeslist of TaxLine
tax_exempt_certificatestring
tipsNonNegativeAmount
customer_feesNonNegativeAmount

Surcharges or convenience fees the customer paid.

tenders requiredlist of Tender

Must sum to the sale total.

SaleLine

FieldTypeAbout
item_skustring

Links the line to an item. Inventory items deplete stock and post COGS.

description requiredstring

Up to 500 characters.

categorystring

Revenue category the posting rules map to an income account.

quantity requiredQuantity
unit_price requiredAmount
discountNonNegativeAmount
taxableboolean

Default: true.

lotstring
dimensionsDimensions

SourceRef

Where the event came from, for click-through from any report line.

FieldTypeAbout
document_typestring
document_numberstring
urlstring (uri)

SourceType

One of: event, manual, bank_transaction, import, reversal, adjusting, agent.

Statement

FieldTypeAbout
id requiredstring
bank_account_id requiredstring
status requiredstring

One of: processing, does_not_foot, staged, failed.

period_startstring (date)
period_endstring (date)
footingobject

Opening plus deposits minus withdrawals must equal closing.

lines_extractedinteger
duplicates_foundinteger

TaxLine

FieldTypeAbout
jurisdiction requiredstring
ratestring
taxable_amountAmount
amount requiredAmount
sourceobject

Where the rate came from, kept with the invoice as of the day it was charged. SYNC fills it for invoices made in the app; a platform may send its own. For a rate from SYNC's approved state rules it cites the official page, the words quoted, the date printed on the page or bulletin, when SYNC read it and who approved it. For a rate the business set, it names who set it and when, and any source and publication date they gave.

TaxReturnOffer

FieldTypeAbout
id requiredstring (uuid)
agency_id requiredstring (uuid)
period_start requiredstring (date)
period_end requiredstring (date)
connection_id requiredstring (uuid)
platform_name requiredstring
pay_from_account_idstring (uuid)
status requiredstring

One of: offered, accepted, declined, filed, withdrawn.

prepared requiredobject

The return as SYNC prepared it when offered; it doesn't change afterwards.

provider_referencestring
confirmationstring
decline_reasonstring
filing_idstring (uuid)
created_at requiredstring (date-time)
updated_at requiredstring (date-time)

Tender

FieldTypeAbout
method requiredstring

One of: card, cash, check, ach, gift_card, store_credit, layaway_deposit, on_account, other.

amount requiredAmount
processorstring

Card processor, so payouts can clear the right clearing account.

processor_payment_idstring

Lets a later payout match this tender exactly.

WebhookDelivery

FieldTypeAbout
id requiredstring
type requiredWebhookEventType
entity_idstring
connection_idstring
created_at requiredstring (date-time)
data requiredobject

WebhookEndpoint

FieldTypeAbout
id requiredstring
url requiredstring (uri)
events requiredlist of WebhookEventType
created_at requiredstring (date-time)

WebhookEventType

One of: connection.activated, connection.disconnected, event.posted, event.needs_review, event.failed, journal_entry.posted, journal_entry.reversed, period.closed, bank_account.feed_stale, bank_transaction.needs_review, import.ready_to_promote, import.promoted, import.reversed, tax_return.offered, tax_return.withdrawn.