Skip to content

Post a scheduled occurrence into the register

POST
/bills/{id}/enter
curl --request POST \
--url https://api.tovarifinancial.com/bills/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/enter \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "occurrenceDate": "example", "settleAgainstTransactionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "confirmPendingMatchTransactionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

X-Idempotency-Key is HONORED (KAN-1302), through the shared idempotency store. A redelivery of the same key for the same bill and occurrenceDate replays the recorded envelope byte for byte — including its original 201 on a first insert — and posts nothing a second time; the same key carrying a different occurrenceDate, or aimed at a different bill, is refused 409 IDEMPOTENCY_CONFLICT. The key is deliberately fingerprinted over {billId, occurrenceDate} ONLY: settleAgainstTransactionId is excluded so that the documented attempt -> 409 BILL_PENDING_MATCH_UNCONFIRMED -> re-issue-the-same-key-with-the-token flow completes rather than conflicting. The key is optional — an unkeyed request behaves exactly as before — but the write is NOT convergent without one, so a client that retries should always send it.

id
required
string format: uuid

Bill id

X-Idempotency-Key
string

Optional idempotency key for safe write retries. Every operation that declares this header reads it. Two cases, told apart per operation: (1) where the operation also documents a 409, replaying this key with a different payload returns 409 IDEMPOTENCY_CONFLICT and replaying it with the same payload returns the original response; (2) where it documents no 409, a replay is reconciled optimistically against a unique key column and answers the original 200.

Media typeapplication/json
object
occurrenceDate
required

Calendar date, ‘YYYY-MM-DD’

string
settleAgainstTransactionId

Confirms settling this occurrence against an already-matched bank row — normally details.pendingMatch.transactionId from this route’s own 409. Re-issue the SAME X-Idempotency-Key with it: the fingerprint deliberately excludes this field.

string format: uuid
nullable
confirmPendingMatchTransactionId

Legacy alias for settleAgainstTransactionId. Prefer the live name.

string format: uuid
nullable
Examplegenerated
{
"occurrenceDate": "example",
"settleAgainstTransactionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"confirmPendingMatchTransactionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Posted transaction + advanced bill

Media typeapplication/json
object
data
required
object
transaction
object
id
string
accountId
string
transactionDate

Calendar date, ‘YYYY-MM-DD’

string
amountCents

Integer minor units (cents)

integer format: int64
status
string
memo
string
nullable
description
string
payeeId
string
nullable
payeeName
string
nullable
budgetCategoryId
string
nullable
bill
object
id
string format: uuid
accountId
string format: uuid
accountName
string
nullable
accountType
string
nullable
payeeId
string
nullable
name
string
memo
string
nullable
budgetCategoryId
string
nullable
categoryName
string
nullable
categoryColorId
string
nullable
sectionId
string
nullable
sectionName
string
nullable
amountCents

Integer minor units (cents)

integer format: int64
direction
string
Allowed values: expense income
frequency
string
Allowed values: once monthly weekly biweekly twice-monthly annually
dayOfMonth
integer
nullable
dayOfWeek
integer
nullable
day2
integer
nullable
annualMonth
integer
nullable
startDate

Calendar date, ‘YYYY-MM-DD’

string
endType
string
Allowed values: never after-count by-date
endCount
integer
nullable
endDate

Calendar date, ‘YYYY-MM-DD’

string
nullable
isActive
boolean
isSettled
boolean
nextDueDate

Calendar date, ‘YYYY-MM-DD’

string
nullable
nextPaymentDate

Calendar date, ‘YYYY-MM-DD’

string
nullable
monthlyEquivCents

Integer minor units (cents)

integer format: int64
nullable
amountMinCents

Integer minor units (cents)

integer format: int64
nullable
amountMaxCents

Integer minor units (cents)

integer format: int64
nullable
affectedAccounts
Array<object>
object
accountId
string
balanceCents

Integer minor units (cents)

integer format: int64
clearedBalanceCents

Integer minor units (cents)

integer format: int64
unclearedBalanceCents

Integer minor units (cents)

integer format: int64
workingBalanceCents

Integer minor units (cents)

integer format: int64
monthChangeCents

Integer minor units (cents)

integer format: int64
affectedBudget
Array<object>
object
categoryId
string
month

Month, ‘YYYY-MM’

string
spentCents

Integer minor units (cents)

integer format: int64
threeMonthAvgCents

Integer minor units (cents)

integer format: int64
message
string
requestId
required
string
timestamp
required
string format: date-time
Example
{
"data": {
"bill": {
"direction": "expense",
"frequency": "once",
"endType": "never"
},
"affectedBudget": [
{
"month": "2026-07"
}
]
}
}

Validation failed — see errorCode / fieldErrors

Media typeapplication/json
object
errorCode
required

Machine-readable error code (AUTH_ERROR_CODES).

string
Allowed values: INVALID_EMAIL_FORMAT USER_ALREADY_EXISTS ORG_NAME_TAKEN INVALID_INVITE_CODE WRONG_PASSWORD USER_NOT_FOUND AUTHENTICATION_FAILED EXPIRED_CODE INVALID_CODE INVALID_PASSWORD VALIDATION_ERROR SIGNUP_FAILED DATABASE_ERROR SERVICE_UNAVAILABLE PLAID_ERROR IDEMPOTENCY_CONFLICT ACCOUNT_ALREADY_LINKED NOT_FOUND
message
required
string
fieldErrors

Optional field-level validation errors, keyed by field name.

object
key
additional properties
Array<string>
requestId
required
string
timestamp
required
string format: date-time
Example
{
"errorCode": "INVALID_EMAIL_FORMAT"
}

Missing, invalid, or expired bearer token

Media typeapplication/json
object
errorCode
required

Machine-readable error code (AUTH_ERROR_CODES).

string
Allowed values: INVALID_EMAIL_FORMAT USER_ALREADY_EXISTS ORG_NAME_TAKEN INVALID_INVITE_CODE WRONG_PASSWORD USER_NOT_FOUND AUTHENTICATION_FAILED EXPIRED_CODE INVALID_CODE INVALID_PASSWORD VALIDATION_ERROR SIGNUP_FAILED DATABASE_ERROR SERVICE_UNAVAILABLE PLAID_ERROR IDEMPOTENCY_CONFLICT ACCOUNT_ALREADY_LINKED NOT_FOUND
message
required
string
fieldErrors

Optional field-level validation errors, keyed by field name.

object
key
additional properties
Array<string>
requestId
required
string
timestamp
required
string format: date-time
Example
{
"errorCode": "INVALID_EMAIL_FORMAT"
}

Authenticated, but the tenant gate refuses the request until the caller resolves a precondition. errorCode is one of EMAIL_NOT_VERIFIED, POLICY_ACCEPTANCE_REQUIRED, or SUBSCRIPTION_REQUIRED, evaluated in exactly that order (contract term CCR-1: email verification first, then policy acceptance, then subscription — so a subscriber who has merely not re-accepted the current policies always sees POLICY_ACCEPTANCE_REQUIRED). A POLICY_ACCEPTANCE_REQUIRED body additionally carries details.outstanding (the policy versions still to accept) and details.firstAcceptance. The SUBSCRIPTION_REQUIRED arm is INERT unless the server-side BILLING_ENABLED flag is exactly the string true; while it is off, only the first two codes are reachable. Not retryable as sent — resolve the named condition, then resend.

Media typeapplication/json
object
errorCode
required

Which precondition refused the request. Evaluated in this order (CCR-1); SUBSCRIPTION_REQUIRED is unreachable while BILLING_ENABLED is not exactly true.

string
Allowed values: EMAIL_NOT_VERIFIED POLICY_ACCEPTANCE_REQUIRED SUBSCRIPTION_REQUIRED
message
required
string
details
object
outstanding
required

Active policy versions the user has not yet accepted.

Array<object>
object
id
required
string format: uuid
policyType
required
string
version
required
integer
title
required
string
firstAcceptance
required

True when the user has accepted no policy before — the client renders the new-signup screen rather than the re-acceptance one.

boolean
requestId
required
string
timestamp
required
string format: date-time
Example
{
"errorCode": "EMAIL_NOT_VERIFIED"
}

Resource not found or not owned by the caller org

Media typeapplication/json
object
errorCode
required

Machine-readable error code (AUTH_ERROR_CODES).

string
Allowed values: INVALID_EMAIL_FORMAT USER_ALREADY_EXISTS ORG_NAME_TAKEN INVALID_INVITE_CODE WRONG_PASSWORD USER_NOT_FOUND AUTHENTICATION_FAILED EXPIRED_CODE INVALID_CODE INVALID_PASSWORD VALIDATION_ERROR SIGNUP_FAILED DATABASE_ERROR SERVICE_UNAVAILABLE PLAID_ERROR IDEMPOTENCY_CONFLICT ACCOUNT_ALREADY_LINKED NOT_FOUND
message
required
string
fieldErrors

Optional field-level validation errors, keyed by field name.

object
key
additional properties
Array<string>
requestId
required
string
timestamp
required
string format: date-time
Example
{
"errorCode": "INVALID_EMAIL_FORMAT"
}

Either IDEMPOTENCY_CONFLICT (the key was already used for a different bill or a different occurrenceDate) or BILL_PENDING_MATCH_UNCONFIRMED (a pending bank row already covers this occurrence; details.pendingMatch names it, and the caller re-issues the SAME key with settleAgainstTransactionId to confirm). Nothing was written in either case.

Media typeapplication/json
object
errorCode
required
string
Allowed values: IDEMPOTENCY_CONFLICT BILL_PENDING_MATCH_UNCONFIRMED
message
required
string
details
object
pendingMatch
required
object
transactionId
required
string format: uuid
amountCents
required

SIGNED ledger cents, exactly as stored.

integer format: int64
transactionDate
required

Calendar date, ‘YYYY-MM-DD’

string
description
required

transactions.description — the text already on the user’s screen. NEVER the raw bank descriptor.

string
requestId
required
string
timestamp
required
string format: date-time
Example
{
"errorCode": "IDEMPOTENCY_CONFLICT"
}

Internal error (no internal detail leaked)

Media typeapplication/json
object
errorCode
required

Machine-readable error code (AUTH_ERROR_CODES).

string
Allowed values: INVALID_EMAIL_FORMAT USER_ALREADY_EXISTS ORG_NAME_TAKEN INVALID_INVITE_CODE WRONG_PASSWORD USER_NOT_FOUND AUTHENTICATION_FAILED EXPIRED_CODE INVALID_CODE INVALID_PASSWORD VALIDATION_ERROR SIGNUP_FAILED DATABASE_ERROR SERVICE_UNAVAILABLE PLAID_ERROR IDEMPOTENCY_CONFLICT ACCOUNT_ALREADY_LINKED NOT_FOUND
message
required
string
fieldErrors

Optional field-level validation errors, keyed by field name.

object
key
additional properties
Array<string>
requestId
required
string
timestamp
required
string format: date-time
Example
{
"errorCode": "INVALID_EMAIL_FORMAT"
}

Service temporarily unavailable — errorCode is SERVICE_UNAVAILABLE. A TRANSIENT, RETRYABLE condition rather than a defect in the request: a query that exceeded its time budget, a lost or refused database connection, a saturated connection pool, or an outage at an upstream provider the request depends on (the authentication provider, or the bank data provider on a bank-connection operation). The identical request may succeed on retry — back off briefly and, on a write, resend the same X-Idempotency-Key where the operation accepts one.

Media typeapplication/json
object
errorCode
required

Machine-readable error code (AUTH_ERROR_CODES).

string
Allowed values: INVALID_EMAIL_FORMAT USER_ALREADY_EXISTS ORG_NAME_TAKEN INVALID_INVITE_CODE WRONG_PASSWORD USER_NOT_FOUND AUTHENTICATION_FAILED EXPIRED_CODE INVALID_CODE INVALID_PASSWORD VALIDATION_ERROR SIGNUP_FAILED DATABASE_ERROR SERVICE_UNAVAILABLE PLAID_ERROR IDEMPOTENCY_CONFLICT ACCOUNT_ALREADY_LINKED NOT_FOUND
message
required
string
fieldErrors

Optional field-level validation errors, keyed by field name.

object
key
additional properties
Array<string>
requestId
required
string
timestamp
required
string format: date-time
Example
{
"errorCode": "INVALID_EMAIL_FORMAT"
}