v49

latestOpenAPI 3.0.0raw.githubusercontent.com2024-12-22168107389.8 KB
accounting/purchaseorders

List PurchaseOrders

get/accounting/purchaseorders

Query parameters

remote_databoolean

Set to true to include data from the original software.

limitnumber

Set to get the number of records.

cursorstring

Set to get the number of records after this cursor.

Headers

x-connection-tokenstring required

The connection token

Response

prev_cursorstring nullable required
next_cursorstring nullable required

Example response

{
  "data": [
    {
      "status": "Pending",
      "issue_date": "2024-06-15T12:00:00Z",
      "purchase_order_number": "PO-001",
      "delivery_date": "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": "2024-07-01T12:00:00Z",
          "company_info_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
          "created_at": "2024-06-15T12:00:00Z",
          "modified_at": "2024-06-15T12:00:00Z"
        }
      ],
      "field_mappings": {
        "custom_field_1": "value1",
        "custom_field_2": "value2"
      },
      "id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
      "remote_id": "po_1234",
      "remote_created_at": "2024-06-15T12:00:00Z",
      "remote_updated_at": "2024-06-15T12:00:00Z",
      "remote_data": {
        "raw_data": {
          "additional_field": "some value"
        }
      },
      "created_at": "2024-06-15T12:00:00Z",
      "modified_at": "2024-06-15T12:00:00Z"
    }
  ]
}