Skip to content

README.md

Latest commit

 

History

History
71 lines (52 loc) · 9.7 KB

README.md

File metadata and controls

71 lines (52 loc) · 9.7 KB

BalanceSheetSDK

(accounting.balance_sheet)

Overview

Available Operations

  • get - Get BalanceSheet

get

Get BalanceSheet

Example Usage

import apideck_unify
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.balance_sheet.get(service_id="salesforce", company_id="12345", pass_through={
        "search": "San Francisco",
    }, filter_={
        "start_date": "2021-01-01",
        "end_date": "2021-12-31",
        "period_count": 3,
        "period_type": apideck_unify.PeriodType.MONTH,
    }, raw=False)

    assert res.get_balance_sheet_response is not None

    # Handle response
    print(res.get_balance_sheet_response)

Parameters

Parameter Type Required Description Example
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
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"
}
filter_ Optional[models.BalanceSheetFilter] ➖ Apply filters {
"start_date": "2021-01-01",
"end_date": "2021-12-31",
"period_count": 3,
"period_type": "month",
"location_id": "123",
"accounting_method": "accrual"
}
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.AccountingBalanceSheetOneResponse

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 */*