Skip to main content

List Purchase Orders

Returns a list of Purchase Orders belonging to your account.

Query Parameters
  • start_cursor string

    The start cursor for Keyset pagination.

  • per_page integer

    Possible values: >= 2 and <= 100

    Default value: 50

    The number of records per page to return.

  • filter object

    The fields, operations, and values to filter the records by.

    • number object
    • eq string required
    • part_location_id object
    • eq string required
    • rejected_by_id object
    • eq string required
    • submitted_for_approval_by_id object
    • eq string required
    • purchased_by_id object
    • eq string required
    • created_by_id object
    • eq string required
    • approved_by_id object
    • eq string required
    • vendor_id object
    • eq string required
    • state object
    • include string required
    • labels object
    • include string required
    • created_at object
      oneOf
    • lt string required
    • updated_at object
      oneOf
    • lt string required
  • sort object

    The fields and direction to sort the results by.

    • id string

      Possible values: [asc, desc]

      Default value: desc

    • created_at string

      Possible values: [asc, desc]

    • updated_at string

      Possible values: [asc, desc]

Responses

OK

Schema

  • start_cursor string

    The current start cursor of the records returned.

  • next_cursor string

    The next cursor to retrieve the next page of records.

  • per_page integer

    The maxumum number of records returned.

  • estimated_remaining_count integer

    The number of remaining records including the returned records, up to a maximum of 500.

  • filtered_by object[]

    The filters applied to the returned record set.

    anyOf
  • number object
  • eq string
  • sorted_by object[]

    The sorts applied to the returned record set.

    anyOf
  • updated_at string

    Possible values: [asc, desc]

  • records object[]
  • id integer
  • number integer

    The Purchase Order Number.

  • description string

    Open text field for Purchase Order description.

  • state string

    Possible values: [draft, submitted_for_approval, rejected, approved, purchased, received_partial, received_full, closed]

    See the Purchase Order Lifecycle Guide for more information about Purchase Order states and how to transition between them.

  • documents_count integer
  • comments_count integer
  • watchers_count integer
  • discount_type string

    The discount type applied to this purchase.

  • tax_1_type string

    The primary tax type on this purchase

  • tax_2_type string

    The secondary tax type on this purchase

  • submitted_for_approval_at date-time

    The date and time at which this Purchase Order was submitted for approval.

  • rejected_at date-time

    The date and time at which this Purchase Order was rejected.

  • approved_at date-time

    The date and time at which this Purchase Order was approved.

  • purchased_at date-time

    The date and time at which this Purchase Order was purchased.

  • received_partial_at date-time

    The date and time at which this Purchase Order was partially received.

  • received_full_at date-time

    The date and time at which this Purchase Order was fully received.

  • closed_at date-time

    The date and time at which this Purchase Order was closed.

  • created_at date-time

    The date and time at which this Purchase Order was created.

  • updated_at date-time

    The date and time at which this Purchase Order was last updated.

  • discount_cents integer

    The amount fo the discount on this Purchase Order in cents.

  • tax_1_cents integer

    The amount of the primary tax on this Purchase Order in cents.

  • tax_1_percentage string

    The percentage for the primary tax.

  • tax_2_cents integer

    The amount of the secondary tax on this Purchase Order in cents.

  • tax_2_percentage string

    The percentage for the secondary tax.

  • subtotal_cents integer

    The subtotal for this Purchase Order in cents.

  • shipping_cents integer

    The shipping amount for this Purchase Order in cents.

  • total_amount_cents integer

    The total amount for this Purchase Order in cents.

  • vendor_id integer

    The ID of the Vendor for this Purchase Order.

  • approved_by_id integer

    The ID of the User who has approved this Purchase Order.

  • created_by_id integer

    The ID of the User who created this Purchase Order.

  • closed_by_id integer

    The ID of the User who has closed this Purchase Order.

  • purchased_by_id integer

    The ID of the User who has purchased this Purchase Order.

  • rejected_by_id integer

    The ID of the User who has rejected this Purchase Order.

  • received_partial_by_id integer

    The ID of the User who has partially received this Purchase Order.

  • received_full_by_id integer

    The ID of the User who has received this Purchase Order in full.

  • submitted_for_approval_by_id integer

    The ID of the User who has submitted this Purchase Order for approval.

  • purchase_order_status_id integer

    The ID of the PurchaseOrderStatus associated with this Purchase Order.

  • part_location_id integer

    The ID of the PartLocation associated with this Purchase Order.

  • custom_fields object

    *Full details on working with Custom Fields here.

  • labels object[]
  • id integer

    Possible values: >= 1

  • name string
  • vendor object
    anyOf
  • name string

    The name of the Vendor.

  • phone string

    The phone number of the Vendor.

  • city string

    The city of the Vendor.

  • region string

    The region, state, province, or territory of the Vendor.

  • postal_code string

    The postal code or ZIP code of the Vendor.

  • country string

    The country of the Vendor.

  • external_id string

    The external identifier of the Vendor.

Loading...