Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-131453851.1 MB
Purchase Orders

List Purchase Orders

List Purchase Orders

get/accounting/purchase-orders

Query parameters

rawboolean

Include raw response. Mostly used for debugging purposes

cursorstring nullable

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

example_downstream_propertystring

All passthrough query parameters are passed along to the connector as is (?pass_through[search]=leads becomes ?search=leads)

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"
}
limitinteger

Number of results to return. Minimum 1, Maximum 200, Default 20

updated_sincestring date-time
supplier_idstring
subsidiary_idstring

Filter by the subsidiary (legal entity) the record belongs to. Only honored on connectors that support multi-entity scoping (e.g. NetSuite OneWorld); ignored elsewhere.

Apply filters

{
  "updated_since": "2020-09-30T07:43:32.000Z",
  "supplier_id": "1234"
}
by'updated_at' | 'created_at'

The field on which to sort the Purchase Orders

direction'asc' | 'desc'

The direction in which to sort the results

Apply sorting

{
  "by": "updated_at",
  "direction": "desc"
}

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.

Response

PurchaseOrders

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": "quickbooks",
  "resource": "PurchaseOrders",
  "operation": "all",
  "data": [
    {
      "id": "12345",
      "downstream_id": "12345",
      "display_id": "12345",
      "po_number": "90000117",
      "reference": "123456",
      "supplier": {
        "id": "12345",
        "display_id": "SUPP00101",
        "display_name": "Windsurf Shop",
        "company_name": "The boring company",
        "address": {
          "id": "123",
          "type": "primary",
          "string": "25 Spring Street, Blackburn, VIC 3130",
          "name": "HQ US",
          "line1": "Main street",
          "line2": "apt #",
          "line3": "Suite #",
          "line4": "delivery instructions",
          "line5": "Attention: Finance Dept",
          "street_number": "25",
          "city": "San Francisco",
          "state": "CA",
          "postal_code": "94104",
          "country": "US",
          "latitude": "40.759211",
          "longitude": "-73.984638",
          "county": "Santa Clara",
          "contact_name": "Elon Musk",
          "salutation": "Mr",
          "phone_number": "111-111-1111",
          "fax": "122-111-1111",
          "email": "elon@musk.com",
          "website": "https://elonmusk.com",
          "notes": "Address notes or delivery instructions.",
          "row_version": "1-12345"
        }
      },
      "subsidiary_id": "12345",
      "company_id": "12345",
      "location_id": "12345",
      "department_id": "12345",
      "status": "open",
      "issued_date": "2020-09-30",
      "delivery_date": "2020-09-30",
      "expected_arrival_date": "2020-09-30",
      "currency": "USD",
      "currency_rate": 0.69,
      "sub_total": 27500,
      "total_tax": 2500,
      "total": 27500,
      "tax_inclusive": true,
      "line_items": [
        {
          "id": "12345",
          "row_id": "12345",
          "code": "120-C",
          "line_number": 1,
          "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
          "type": "sales_item",
          "tax_amount": 27500,
          "total_amount": 27500,
          "quantity": 1,
          "unit_price": 27500.5,
          "unit_of_measure": "pc.",
          "discount_percentage": 0.01,
          "discount_amount": 19.99,
          "service_date": "2024-01-15",
          "category_id": "12345",
          "location_id": "12345",
          "department_id": "12345",
          "subsidiary_id": "12345",
          "shipping_id": "12345",
          "memo": "Some memo",
          "prepaid": true,
          "item": {
            "id": "12344",
            "code": "120-C",
            "name": "Model Y"
          },
          "tax_applicable_on": "Domestic_Purchase_of_Goods_and_Services",
          "tax_recoverability": "Fully_Recoverable",
          "tax_method": "Due_to_Supplier",
          "worktags": [
            {
              "id": "123456",
              "value": "New York"
            }
          ],
          "tax_rate": {
            "id": "123456",
            "code": "N-T",
            "name": "GST on Purchases",
            "rate": 10
          },
          "tracking_categories": [
            {
              "id": "123456",
              "code": "100",
              "name": "New York",
              "parent_id": "123456",
              "parent_name": "New York"
            }
          ],
          "ledger_account": {
            "id": "123456",
            "name": "Bank account",
            "nominal_code": "N091",
            "code": "453",
            "parent_id": "123456",
            "display_id": "123456"
          },
          "custom_fields": [
            {
              "id": "2389328923893298",
              "name": "employee_level",
              "description": "Employee Level",
              "value": "Uses Salesforce and Marketo"
            }
          ],
          "row_version": "1-12345",
          "updated_by": "12345",
          "created_by": "12345",
          "created_at": "2020-09-30T07:43:32.000Z",
          "updated_at": "2020-09-30T07:43:32.000Z"
        }
      ],
      "billing_address": {
        "id": "123",
        "type": "primary",
        "string": "25 Spring Street, Blackburn, VIC 3130",
        "name": "HQ US",
        "line1": "Main street",
        "line2": "apt #",
        "line3": "Suite #",
        "line4": "delivery instructions",
        "line5": "Attention: Finance Dept",
        "street_number": "25",
        "city": "San Francisco",
        "state": "CA",
        "postal_code": "94104",
        "country": "US",
        "latitude": "40.759211",
        "longitude": "-73.984638",
        "county": "Santa Clara",
        "contact_name": "Elon Musk",
        "salutation": "Mr",
        "phone_number": "111-111-1111",
        "fax": "122-111-1111",
        "email": "elon@musk.com",
        "website": "https://elonmusk.com",
        "notes": "Address notes or delivery instructions.",
        "row_version": "1-12345"
      },
      "shipping_address": {
        "id": "123",
        "type": "primary",
        "string": "25 Spring Street, Blackburn, VIC 3130",
        "name": "HQ US",
        "line1": "Main street",
        "line2": "apt #",
        "line3": "Suite #",
        "line4": "delivery instructions",
        "line5": "Attention: Finance Dept",
        "street_number": "25",
        "city": "San Francisco",
        "state": "CA",
        "postal_code": "94104",
        "country": "US",
        "latitude": "40.759211",
        "longitude": "-73.984638",
        "county": "Santa Clara",
        "contact_name": "Elon Musk",
        "salutation": "Mr",
        "phone_number": "111-111-1111",
        "fax": "122-111-1111",
        "email": "elon@musk.com",
        "website": "https://elonmusk.com",
        "notes": "Address notes or delivery instructions.",
        "row_version": "1-12345"
      },
      "ledger_account": {
        "id": "123456",
        "name": "Bank account",
        "nominal_code": "N091",
        "code": "453",
        "parent_id": "123456",
        "display_id": "123456"
      },
      "template_id": "123456",
      "discount_percentage": 5.5,
      "bank_account": {
        "bank_name": "Chase Bank",
        "account_number": "123465",
        "account_name": "Main Operating Account",
        "account_type": "credit_card",
        "iban": "GB33BUKB20201555555555",
        "bic": "CHASUS33",
        "routing_number": "021000021",
        "bsb_number": "062-001",
        "branch_identifier": "001",
        "bank_code": "BNH",
        "currency": "USD",
        "country": "US"
      },
      "due_date": "2020-10-30",
      "payment_method": "cash",
      "terms": "Net 30 days",
      "terms_id": "12345",
      "tax_code": "1234",
      "tax_method": "Due to supplier",
      "issued_method": "Email",
      "issued_email": "john.doe@example.com",
      "channel": "email",
      "memo": "Thank you for the partnership and have a great day!",
      "notes": "This is a test purchase order",
      "tracking_categories": [
        {
          "id": "123456",
          "code": "100",
          "name": "New York",
          "parent_id": "123456",
          "parent_name": "New York"
        }
      ],
      "custom_fields": [
        {
          "id": "2389328923893298",
          "name": "employee_level",
          "description": "Employee Level",
          "value": "Uses Salesforce and Marketo"
        }
      ],
      "row_version": "1-12345",
      "updated_by": "12345",
      "created_by": "12345",
      "updated_at": "2020-09-30T07:43:32.000Z",
      "created_at": "2020-09-30T07:43:32.000Z",
      "pass_through": [
        {
          "extend_paths": [
            {
              "path": "$.nested.property",
              "value": {
                "TaxClassificationRef": {
                  "value": "EUC-99990201-V1-00020000"
                }
              }
            }
          ]
        }
      ]
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    },
    "total_count": 1,
    "warnings": [
      {
        "type": "downstream_request_failed",
        "status_code": 429,
        "operation": "getManager"
      }
    ]
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}