Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-131453851.1 MB
Bank Feed Statements

Create Bank Feed Statement

Create Bank Feed Statement

post/accounting/bank-feed-statements

Query parameters

rawboolean

Include raw response. Mostly used for debugging purposes

Headers

x-apideck-consumer-idstring required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

x-apideck-company-idstring

The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings.

Request body

idstring required

A unique identifier for an object.

bank_feed_account_idstring

The ID of the bank feed account this statement belongs to.

status'pending' | 'rejected' | 'success'

The current status of the bank feed statement.

start_datestring date-time

Start date of the bank feed statement.

end_datestring date-time

End date of the bank feed statement.

start_balancenumber

Balance amount at the start of the period.

start_balance_credit_or_debit'credit' | 'debit'

Whether the amount is a credit or debit.

end_balancenumber

Balance amount at the end of the period.

end_balance_credit_or_debit'credit' | 'debit'

Whether the amount is a credit or debit.

created_atstring date-time nullable

The date and time when the object was created.

created_bystring nullable

The user who created the object.

updated_atstring date-time nullable

The date and time when the object was last updated.

updated_bystring nullable

The user who last updated the object.

Example request

{
  "id": "12345",
  "bank_feed_account_id": "acc_456",
  "status": "pending",
  "start_date": "2021-05-01T12:00:00.000Z",
  "end_date": "2025-01-31T12:00:00.000Z",
  "start_balance": 10500.25,
  "start_balance_credit_or_debit": "debit",
  "end_balance": 9800.5,
  "end_balance_credit_or_debit": "debit",
  "transactions": [
    {
      "posted_date": "2025-01-15T12:00:00.000Z",
      "description": "Payment received from ACME Corp",
      "amount": 250,
      "credit_or_debit": "debit",
      "source_transaction_id": "txn_987",
      "counterparty": "ACME Corp",
      "reference": "INV-2025-01",
      "transaction_type": "payment"
    }
  ],
  "created_at": "2020-09-30T07:43:32.000Z",
  "created_by": "12345",
  "updated_at": "2020-09-30T07:43:32.000Z",
  "updated_by": "12345"
}

Response

Bank Feed Statements

status_codeinteger required

HTTP Response Status Code

statusstring required

HTTP Response Status

servicestring required

Apideck ID of service provider

resourcestring required

Unified API resource name

operationstring required

Operation performed

_rawRaw nullable

Raw response from the integration when raw=true query param is provided

Example response

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "bills",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}