API Reference
Start typing to search…

Get Postings

get https://api.sandbox.usebasis.co/profiles//reports/postings

Overview

Generate a Postings Report for an Account. Given a set of criteria, the Report will return the list of posted transactions on the Account.

Use cases

  • Produce a list of transactions and related details from a specific Account for analysis.
  • Search for a Posting related to a particular business transaction (e.g. an Invoice of a certain dollar-amount).
  • Pull transaction metadata such as Check Images, Receipts, and Invoices to add business context to a Posting.
Log in to see full request history
Path Params
uuid
required
Query Params
label
array of strings

Include postings which belong to accounts matching these Account Labels.

Label
attachment_type
array of strings

Include postings with these attachment types.

integer
1 to 10000
Defaults to 100

Number of results to return per page.

integer
≥ 1
Defaults to 1

Page number out of total pages at given page size (per_page).

Responses

Response body
object
integer
required

Total records available.

postings
array of objects
required
Postings*
object
uuid
required

Unique identifier for the Posting.

string
required

Label of the Account that the Posting is associated with in ltree format. See Account Labels for more information on the format.

offsetting_accounts
array of objects
required

Offsetting Accounts associated with this Posting. Offsetting Accounts represent the opposite side of a transaction as recorded in a double-entry ledger. As a result, offsetting_accounts can be used for the transaction category.

For example, a Posting observed in a checking account that was income from a customer may have offsetting_accounts populated with revenue.operating_revenue, indicating that the income is from operations (versus financing or investing).

offsetting_accounts are lightweight representations of ledger accounts, containing only the accounts' names and labels, presented in ltree format. See Account Labels for more information on the format.

Offsetting Labels*
object
string
required
string
required
string
required
date-time
required

Date and time that the transaction posted.

required

A brief, single-line summary of the activity related to this Posting.

required

Additional transaction text that can be displayed along with the summary.

required

A business reason for the Posting as observed from the Platform.

debit_amount
object
required

An unsigned amount that this Posting Debits the Account.

credit_amount
object
required

An unsigned amount that this Posting Credits the Account.

effective_amount
object
required

A signed amount that indicates whether a Posting is a Debit or Credit. Positive values are Debits and negative values are Credits.

Accounting conventions for whether Debits or Credits increase Account balances are as follows:

  • Asset Accounts: Debits increase the Account balance (Debit-normal)
  • Liability Accounts: Credits increase the Account balance (Credit-normal)
  • Equity Accounts: Credits increase the Account balance (Credit-normal)
  • Revenue Accounts: Credits increase the Account balance (Credit-normal)
  • Expense Accounts: Debits increase the Account balance (Debit-normal)

Several examples of common Postings can help to illustrate the relationship between effective_amount and Debit vs. Credit:

  • Depositing cash into a Checking Account: Checking Accounts are Asset Accounts and are Debit-normal. A Posting that increases the balance will have a positive effective_amount.
  • Spending on Expenses: Expense Accounts are Debit-normal. A Posting that increases the balance will have a positive effective_amount.
  • Spending from a Credit Card: Credit Card Accounts are Liability Accounts and are Credit-normal A Posting that increases the balance will have a negative effective_amount.
  • Paying down a Credit Card: Credit Card Accounts are Liability Accounts and are Credit-normal. A Posting that decreases the balance will have a positive effective_amount.
string
required

Transaction Type indicates the method of value transfer for this Posting.

Notably:

  • book-transfer indicates a transfer between a company's accounts at a single institution. For example, a transfer from a Checking Account to a Credit Card Account to pay the statement balance would be classified as a book-transfer.
  • other indicates either an unsupported transfer method or a transfer of value to/from the Institution Platform. For example, a payment of interest in an interest-bearing savings account would be classified as other.

ach book-transfer card check other rtp swift wire

attachments
array
required

List of attachments associated with a Posting.

Attachments*
integer
required

Number of records returned in this request.

Updated 12 months ago

Did this page help you?
Language
Credentials
OAuth2
URL

Updated 12 months ago

Did this page help you?