Sign in

v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB
transactions

Update a transaction

Update the budget for an existing transaction.

put/v3/spend/transactions/{transactionId}

Path parameters

transactionIdstring required

BILL-generated ID or UUID of the transaction

Example:{{se_transaction_uuid}}

Headers

apiTokenstring nullable

Access token for Spend & Expense API authentication

Example:{{api_token}}

Request body

budgetIdstring required

BILL-generated ID or UUID of the budget linked with the transaction

Example request

{
  "budgetId": "{{se_budget_uuid}}"
}

Response

Update a transaction response

idstring

BILL-generated ID of the transaction

uuidstring

BILL-generated UUID of the transaction

childTransactionIdsstring[]

BILL-generated IDs of child transactions associated with the current transaction

childTransactionUuidsstring[]

BILL-generated IDs of child transactions associated with the current transaction

isLockedboolean

Set as true if the transaction is locked

isReconciledboolean

Set as true if the transaction is reconciled

transactionType'CLEAR' | 'DECLINE' | 'AUTHORIZATION'

Transaction type.

parentTransactionIdstring

BILL-generated ID of the parent transaction. This field is set on child transactions when a parent transaction is split.

userIdstring

BILL-generated ID of the user who created the transaction

userUuidstring

BILL-generated UUID of the user who created the transaction

userNamestring

Display name of the user who created the transaction

rawMerchantNamestring

Raw merchant name for the transaction

merchantNamestring

Readable (cleaned) merchant name for the transaction

budgetIdstring

BILL-generated ID of the budget linked with the transaction

budgetUuidstring

BILL-generated UUID of the budget linked with the transaction

budgetNamestring

Name of the budget linked with the transaction

parentBudgetUuidstring

BILL-generated UUID of the parent budget linked with the transaction

originalAuthTransactionIdstring

BILL-generated ID of the originating authorization transaction

originalAuthTransactionUuidstring

BILL-generated UUID of the originating authorization transaction.

After a transaction is authorized, it is set as cleared when it is complete. The originalAuthTransactionUuid ties the cleared transaction to the authorized transaction. The value is null when the transaction is not authorized.

isCreditboolean

Set as true if the transaction is a credit

receiptRequiredboolean

Set as true if a receipt is required to complete the transaction

reviewRequiredboolean

Set as true if a review is required to complete the transaction

status'APPROVED' | 'COMPLETE' | 'DECLINED' | 'DENIED' | 'DISPUTE_LOST' | 'DISPUTE_UPDATE' | 'DISPUTE_WON' | 'DISPUTED' | 'DO_NOT_SYNC' | 'INCOMPLETE' | 'NONE' | 'PENDING' | 'PTR_INCOMPLETE' | 'PTR_NEEDS_YOUR_APPROVAL' | 'PTR_PENDING_APPROVAL' | 'PTR_UPCOMING_APPROVAL' | 'REVIEWED'

Transaction status

occurredTimestring date-time

Created date and time

updatedTimestring date-time

Updated date and time

authorizedTimestring date-time

Transaction authorized date and time

completeboolean

Set as true if the transaction has all the required fields completed

pointsAwardedinteger

Points awarded for the transaction. This value is 0 until the transaction is cleared.

Note: Only ADMIN users can view any awarded points.

network'VISA' | 'MASTERCARD'

Transaction network type.

isParentboolean

Set as true if the transaction is the parent of another transaction

amountnumber

Transaction amount including fees.

When amount is negative, the transaction is a reversal or refund.

  • Reversal: For a reversal (cancel before funds are settled), transactionType is set as AUTHORIZATION and amount is a negative value.
  • Refund: For a refund (cancel after funds are settled), transactionType is set as CLEAR and amount is a negative value.
transactedAmountnumber

Transaction amount not including fees

feesnumber

Sum of transaction fees (including foreignExchangeFee)

foreignExchangeFeenumber

Foreign exchange fee for the transaction (if any)

receiptStatus'VALIDATED' | 'NOT_VALIDATED' | 'ATTACHED' | 'MISSING' | 'NOT_REQUIRED' | 'NOT_ATTACHED' | 'UNSPECIFIED'

Receipt status.

matchedClearTransactionIdstring

BILL-generated ID of the cleared transaction. Use this ID to identify the transaction after it is cleared.

matchedClearTransactionUuidstring

BILL-generated UUID of the cleared transaction. Use this ID to identify the transaction after it is cleared.

cardIdstring

BILL-generated ID of the card used to make the transaction

cardUuidstring

BILL-generated UUID of the card used to make the transaction

cardLastFourstring

Last four digits of the card number used to make the transaction

cardType'PHYSICAL' | 'VIRTUAL_MEMBER' | 'VIRTUAL_VENDOR' | 'VIRTUAL'

Type of the card used to make the transaction

receiptSyncStatus'NOT_SYNCED' | 'SYNCED' | 'SYNC_ERROR' | 'NO_ATTACHMENTS'

Transaction receipt sync status.

merchantCategoryCodestring

Merchant category code

declineReasonstring

Human-readable transaction decline reason. This field is available when transactionType is set as DECLINE.

declineInternalReasonCodestring

Transaction decline reason code. This field is available when transactionType is set as DECLINE.

cardPresentboolean

Set as true if a physical card was present for the transaction

disputeStatus'SUBMITTED' | 'IN_PROGRESS' | 'CLOSED_WON' | 'CLOSED_LOST'

Dispute status for the transaction. This information is available when the transaction has been disputed.