Skip to content

Latest commit

 

History

History
169 lines (120 loc) · 11 KB

README.md

File metadata and controls

169 lines (120 loc) · 11 KB
Raw

Purchaseorders

(accounting.purchaseorders)

Available Operations

  • list - List PurchaseOrders
  • create - Create Purchase Orders
  • retrieve - Retrieve Purchase Orders

list

List PurchaseOrders

Example Usage

from panora_sdk import Panora

s = Panora(
    api_key="<YOUR_API_KEY_HERE>",
)


res = s.accounting.purchaseorders.list(x_connection_token="<value>", remote_data=True, limit=10, cursor="1b8b05bb-5273-4012-b520-8657b0b90874")

if res is not None:
    while True:
        # handle items

        res = res.Next()
        if res is None:
            break

Parameters

Parameter Type Required Description Example
x_connection_token str ✔️ The connection token
remote_data Optional[bool] ➖ Set to true to include data from the original software. true
limit Optional[float] ➖ Set to get the number of records. 10
cursor Optional[str] ➖ Set to get the number of records after this cursor. 1b8b05bb-5273-4012-b520-8657b0b90874
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.ListAccountingPurchaseOrderResponse

Errors

Error Object Status Code Content Type
models.SDKError 4xx-5xx /

create

Create Purchase Orders in any supported Accounting software

Example Usage

import dateutil.parser
from panora_sdk import Panora

s = Panora(
    api_key="<YOUR_API_KEY_HERE>",
)


res = s.accounting.purchaseorders.create(x_connection_token="<value>", unified_accounting_purchaseorder_input={
    "status": "Pending",
    "issue_date": dateutil.parser.isoparse("2024-06-15T12:00:00Z"),
    "purchase_order_number": "PO-001",
    "delivery_date": dateutil.parser.isoparse("2024-07-15T12:00:00Z"),
    "delivery_address": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
    "customer": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
    "vendor": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
    "memo": "Purchase order for Q3 inventory",
    "company_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
    "total_amount": 100000,
    "currency": "USD",
    "exchange_rate": "1.2",
    "tracking_categories": [
        "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
    ],
    "accounting_period_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
    "line_items": [
        {
            "name": "Net Income",
            "value": 100000,
            "type": "Operating Activities",
            "parent_item": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
            "remote_id": "report_item_1234",
            "remote_generated_at": dateutil.parser.isoparse("2024-07-01T12:00:00Z"),
            "company_info_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
            "created_at": dateutil.parser.isoparse("2024-06-15T12:00:00Z"),
            "modified_at": dateutil.parser.isoparse("2024-06-15T12:00:00Z"),
        },
    ],
    "field_mappings": {},
}, remote_data=False)

if res is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description Example
x_connection_token str ✔️ The connection token
unified_accounting_purchaseorder_input models.UnifiedAccountingPurchaseorderInput ✔️ N/A
remote_data Optional[bool] ➖ Set to true to include data from the original Accounting software. false
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.UnifiedAccountingPurchaseorderOutput

Errors

Error Object Status Code Content Type
models.SDKError 4xx-5xx /

retrieve

Retrieve Purchase Orders from any connected Accounting software

Example Usage

from panora_sdk import Panora

s = Panora(
    api_key="<YOUR_API_KEY_HERE>",
)


res = s.accounting.purchaseorders.retrieve(x_connection_token="<value>", id="801f9ede-c698-4e66-a7fc-48d19eebaa4f", remote_data=False)

if res is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description Example
x_connection_token str ✔️ The connection token
id str ✔️ id of the purchaseorder you want to retrieve. 801f9ede-c698-4e66-a7fc-48d19eebaa4f
remote_data Optional[bool] ➖ Set to true to include data from the original Accounting software. false
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.UnifiedAccountingPurchaseorderOutput

Errors

Error Object Status Code Content Type
models.SDKError 4xx-5xx /