BankFeedStatements

(accounting.bank_feed_statements)

Overview

Available Operations

list - List Bank Feed Statements
create - Create Bank Feed Statement
get - Get Bank Feed Statement
update - Update Bank Feed Statement
delete - Delete Bank Feed Statement

list

List Bank Feed Statements

Example Usage

from apideck_unify import Apideck
import os


with Apideck(
    consumer_id="test-consumer",
    app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
    api_key=os.getenv("APIDECK_API_KEY", ""),
) as apideck:

    res = apideck.accounting.bank_feed_statements.list(raw=False, service_id="salesforce", company_id="12345", limit=20, pass_through={
        "search": "San Francisco",
    }, fields="id,updated_at")

    while res is not None:
        # Handle items

        res = res.next()

Parameters

Parameter	Type	Required	Description	Example
`raw`	Optional[bool]	➖	Include raw response. Mostly used for debugging purposes
`consumer_id`	Optional[str]	➖	ID of the consumer which you want to get or push data from	test-consumer
`app_id`	Optional[str]	➖	The ID of your Unify application	dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX
`service_id`	Optional[str]	➖	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	salesforce
`company_id`	Optional[str]	➖	The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings.	12345
`cursor`	OptionalNullable[str]	➖	Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
`limit`	Optional[int]	➖	Number of results to return. Minimum 1, Maximum 200, Default 20
`pass_through`	Dict[str, Any]	➖	Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads	{ "search": "San Francisco" }
`fields`	OptionalNullable[str]	➖	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city` In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.	id,updated_at
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.AccountingBankFeedStatementsAllResponse

Errors

Error Type	Status Code	Content Type
models.BadRequestResponse	400	application/json
models.UnauthorizedResponse	401	application/json
models.PaymentRequiredResponse	402	application/json
models.NotFoundResponse	404	application/json
models.UnprocessableResponse	422	application/json
models.APIError	4XX, 5XX	/

create

Create Bank Feed Statement

Example Usage

import apideck_unify
from apideck_unify import Apideck
from apideck_unify.utils import parse_datetime
import os


with Apideck(
    consumer_id="test-consumer",
    app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
    api_key=os.getenv("APIDECK_API_KEY", ""),
) as apideck:

    res = apideck.accounting.bank_feed_statements.create(raw=False, service_id="salesforce", company_id="12345", bank_feed_account_id="acc_456", status=apideck_unify.StatementStatus.PENDING, start_date=parse_datetime("2021-05-01T12:00:00.000Z"), end_date=parse_datetime("2025-01-31T12:00:00.000Z"), start_balance=10500.25, start_balance_credit_or_debit=apideck_unify.CreditOrDebit.DEBIT, end_balance=9800.5, end_balance_credit_or_debit=apideck_unify.CreditOrDebit.DEBIT, transactions=[
        {
            "posted_date": parse_datetime("2025-01-15T12:00:00.000Z"),
            "description": "Payment received from ACME Corp",
            "amount": 250,
            "credit_or_debit": apideck_unify.CreditOrDebit.DEBIT,
            "source_transaction_id": "txn_987",
            "counterparty": "ACME Corp",
            "reference": "INV-2025-01",
            "transaction_type": apideck_unify.BankFeedStatementTransactionType.PAYMENT,
        },
        {
            "posted_date": parse_datetime("2025-01-15T12:00:00.000Z"),
            "description": "Payment received from ACME Corp",
            "amount": 250,
            "credit_or_debit": apideck_unify.CreditOrDebit.DEBIT,
            "source_transaction_id": "txn_987",
            "counterparty": "ACME Corp",
            "reference": "INV-2025-01",
            "transaction_type": apideck_unify.BankFeedStatementTransactionType.PAYMENT,
        },
        {
            "posted_date": parse_datetime("2025-01-15T12:00:00.000Z"),
            "description": "Payment received from ACME Corp",
            "amount": 250,
            "credit_or_debit": apideck_unify.CreditOrDebit.DEBIT,
            "source_transaction_id": "txn_987",
            "counterparty": "ACME Corp",
            "reference": "INV-2025-01",
            "transaction_type": apideck_unify.BankFeedStatementTransactionType.PAYMENT,
        },
    ])

    assert res.create_bank_feed_statement_response is not None

    # Handle response
    print(res.create_bank_feed_statement_response)

Parameters

Parameter	Type	Required	Description	Example
`raw`	Optional[bool]	➖	Include raw response. Mostly used for debugging purposes
`consumer_id`	Optional[str]	➖	ID of the consumer which you want to get or push data from	test-consumer
`app_id`	Optional[str]	➖	The ID of your Unify application	dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX
`service_id`	Optional[str]	➖	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	salesforce
`company_id`	Optional[str]	➖	The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings.	12345
`bank_feed_account_id`	Optional[str]	➖	The ID of the bank feed account this statement belongs to.	acc_456
`status`	Optional[models.StatementStatus]	➖	The current status of the bank feed statement.	pending
`start_date`	date	➖	Start date of the bank feed statement.	2021-05-01T12:00:00.000Z
`end_date`	date	➖	End date of the bank feed statement.	2025-01-31T12:00:00.000Z
`start_balance`	Optional[float]	➖	Balance amount at the start of the period.	10500.25
`start_balance_credit_or_debit`	Optional[models.CreditOrDebit]	➖	Whether the amount is a credit or debit.	debit
`end_balance`	Optional[float]	➖	Balance amount at the end of the period.	9800.5
`end_balance_credit_or_debit`	Optional[models.CreditOrDebit]	➖	Whether the amount is a credit or debit.	debit
`transactions`	List[models.Transactions]	➖	List of transactions in the bank feed statement.
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.AccountingBankFeedStatementsAddResponse

Errors

Error Type	Status Code	Content Type
models.BadRequestResponse	400	application/json
models.UnauthorizedResponse	401	application/json
models.PaymentRequiredResponse	402	application/json
models.NotFoundResponse	404	application/json
models.UnprocessableResponse	422	application/json
models.APIError	4XX, 5XX	/

get

Get Bank Feed Statement

Example Usage

from apideck_unify import Apideck
import os


with Apideck(
    consumer_id="test-consumer",
    app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
    api_key=os.getenv("APIDECK_API_KEY", ""),
) as apideck:

    res = apideck.accounting.bank_feed_statements.get(id="<id>", service_id="salesforce", company_id="12345", raw=False, fields="id,updated_at")

    assert res.get_bank_feed_statement_response is not None

    # Handle response
    print(res.get_bank_feed_statement_response)

Parameters

Parameter	Type	Required	Description	Example
`id`	str	✔️	ID of the record you are acting upon.
`consumer_id`	Optional[str]	➖	ID of the consumer which you want to get or push data from	test-consumer
`app_id`	Optional[str]	➖	The ID of your Unify application	dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX
`service_id`	Optional[str]	➖	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	salesforce
`company_id`	Optional[str]	➖	The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings.	12345
`raw`	Optional[bool]	➖	Include raw response. Mostly used for debugging purposes
`fields`	OptionalNullable[str]	➖	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city` In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.	id,updated_at
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.AccountingBankFeedStatementsOneResponse

Errors

Error Type	Status Code	Content Type
models.BadRequestResponse	400	application/json
models.UnauthorizedResponse	401	application/json
models.PaymentRequiredResponse	402	application/json
models.NotFoundResponse	404	application/json
models.UnprocessableResponse	422	application/json
models.APIError	4XX, 5XX	/

update

Update Bank Feed Statement

Example Usage

import apideck_unify
from apideck_unify import Apideck
from apideck_unify.utils import parse_datetime
import os


with Apideck(
    consumer_id="test-consumer",
    app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
    api_key=os.getenv("APIDECK_API_KEY", ""),
) as apideck:

    res = apideck.accounting.bank_feed_statements.update(id="<id>", service_id="salesforce", raw=False, bank_feed_account_id="acc_456", status=apideck_unify.StatementStatus.PENDING, start_date=parse_datetime("2021-05-01T12:00:00.000Z"), end_date=parse_datetime("2025-01-31T12:00:00.000Z"), start_balance=10500.25, start_balance_credit_or_debit=apideck_unify.CreditOrDebit.DEBIT, end_balance=9800.5, end_balance_credit_or_debit=apideck_unify.CreditOrDebit.DEBIT, transactions=[
        {
            "posted_date": parse_datetime("2025-01-15T12:00:00.000Z"),
            "description": "Payment received from ACME Corp",
            "amount": 250,
            "credit_or_debit": apideck_unify.CreditOrDebit.DEBIT,
            "source_transaction_id": "txn_987",
            "counterparty": "ACME Corp",
            "reference": "INV-2025-01",
            "transaction_type": apideck_unify.BankFeedStatementTransactionType.PAYMENT,
        },
        {
            "posted_date": parse_datetime("2025-01-15T12:00:00.000Z"),
            "description": "Payment received from ACME Corp",
            "amount": 250,
            "credit_or_debit": apideck_unify.CreditOrDebit.DEBIT,
            "source_transaction_id": "txn_987",
            "counterparty": "ACME Corp",
            "reference": "INV-2025-01",
            "transaction_type": apideck_unify.BankFeedStatementTransactionType.PAYMENT,
        },
    ])

    assert res.update_bank_feed_statement_response is not None

    # Handle response
    print(res.update_bank_feed_statement_response)

Parameters

Parameter	Type	Required	Description	Example
`id`	str	✔️	ID of the record you are acting upon.
`consumer_id`	Optional[str]	➖	ID of the consumer which you want to get or push data from	test-consumer
`app_id`	Optional[str]	➖	The ID of your Unify application	dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX
`service_id`	Optional[str]	➖	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	salesforce
`raw`	Optional[bool]	➖	Include raw response. Mostly used for debugging purposes
`bank_feed_account_id`	Optional[str]	➖	The ID of the bank feed account this statement belongs to.	acc_456
`status`	Optional[models.StatementStatus]	➖	The current status of the bank feed statement.	pending
`start_date`	date	➖	Start date of the bank feed statement.	2021-05-01T12:00:00.000Z
`end_date`	date	➖	End date of the bank feed statement.	2025-01-31T12:00:00.000Z
`start_balance`	Optional[float]	➖	Balance amount at the start of the period.	10500.25
`start_balance_credit_or_debit`	Optional[models.CreditOrDebit]	➖	Whether the amount is a credit or debit.	debit
`end_balance`	Optional[float]	➖	Balance amount at the end of the period.	9800.5
`end_balance_credit_or_debit`	Optional[models.CreditOrDebit]	➖	Whether the amount is a credit or debit.	debit
`transactions`	List[models.Transactions]	➖	List of transactions in the bank feed statement.
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.AccountingBankFeedStatementsUpdateResponse

Errors

Error Type	Status Code	Content Type
models.BadRequestResponse	400	application/json
models.UnauthorizedResponse	401	application/json
models.PaymentRequiredResponse	402	application/json
models.NotFoundResponse	404	application/json
models.UnprocessableResponse	422	application/json
models.APIError	4XX, 5XX	/

delete

Delete Bank Feed Statement

Example Usage

from apideck_unify import Apideck
import os


with Apideck(
    consumer_id="test-consumer",
    app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
    api_key=os.getenv("APIDECK_API_KEY", ""),
) as apideck:

    res = apideck.accounting.bank_feed_statements.delete(id="<id>", service_id="salesforce", raw=False)

    assert res.delete_bank_feed_statement_response is not None

    # Handle response
    print(res.delete_bank_feed_statement_response)

Parameters

Parameter	Type	Required	Description	Example
`id`	str	✔️	ID of the record you are acting upon.
`consumer_id`	Optional[str]	➖	ID of the consumer which you want to get or push data from	test-consumer
`app_id`	Optional[str]	➖	The ID of your Unify application	dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX
`service_id`	Optional[str]	➖	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	salesforce
`raw`	Optional[bool]	➖	Include raw response. Mostly used for debugging purposes
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.AccountingBankFeedStatementsDeleteResponse

Errors

Error Type	Status Code	Content Type
models.BadRequestResponse	400	application/json
models.UnauthorizedResponse	401	application/json
models.PaymentRequiredResponse	402	application/json
models.NotFoundResponse	404	application/json
models.UnprocessableResponse	422	application/json
models.APIError	4XX, 5XX	/

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

BankFeedStatements

Overview

Available Operations

list

Example Usage

Parameters

Response

Errors

create

Example Usage

Parameters

Response

Errors

get

Example Usage

Parameters

Response

Errors

update

Example Usage

Parameters

Response

Errors

delete

Example Usage

Parameters

Response

Errors

FilesExpand file tree

README.md

Latest commit

History

README.md

File metadata and controls

BankFeedStatements

Overview

Available Operations

list

Example Usage

Parameters

Response

Errors

create

Example Usage

Parameters

Response

Errors

get

Example Usage

Parameters

Response

Errors

update

Example Usage

Parameters

Response

Errors

delete

Example Usage

Parameters

Response

Errors