Purchase Orders - Bulk

Bulk update and delete operations on purchase orders.

Attributes

attachment attachment
Response

The file attachment associated with this purchase order.

attachment_id integer
Request

ID of the file attachment associated with this purchase order.

bill_from contact entry
Response

The billing address of the sender (bill from contact data) on this purchase order.

bill_to contact entry
Response

The billing address of the recipient (bill to contact data) on this purchase order.

created_at string
Response Parameter `filter` Parameter `sort`

Timestamp when this purchase order was created.

creator person
Response

The person who created this purchase order.

creator_id integer
Parameter `filter`

ID of the person who created this purchase order.

currency string
Response Request

The currency of this purchase order.

currency_default object
Response

The purchase order amount converted to the organization's default currency.

currency_normalized object
Response

The purchase order amount converted to the normalized (reporting) currency.

deal deal
Response

The deal (budget) this purchase order is linked to.

deal_id integer
Request Parameter `filter` Parameter `sort`

ID of the deal (budget) this purchase order is linked to.

deal_name object
Parameter `sort`

The name of the deal (budget) this purchase order is linked to.

delivery_on string
Response Request Parameter `filter` Parameter `sort`

Date when the goods or services covered by this purchase order are expected to be delivered.

document_type document type
Response

The document type associated with this purchase order.

document_type_id integer
Request

ID of the document type associated with this purchase order.

email_key string
Response

A unique key used to identify this purchase order when receiving it via email.

exchange_date string
Response

The date used for applying the exchange rate when converting this purchase order's currency.

exchange_rate number
Response

The exchange rate applied to convert this purchase order's currency to the organization's default currency.

exported object
Response

Whether this purchase order has been exported to an accounting system.

exported_at string
Response

Timestamp when this purchase order was exported to an accounting system, or null if not yet exported.

export_id string
Response

The external identifier assigned when this purchase order was exported to an accounting system.

export_integration_type_id integer
Response Enum

The export integration type id.

Enum Values (11 values)

  • 1
    CPP
  • 2
    Quickbooks
  • 3
    Xero
  • 4
    Exact
  • 5
    Economic
  • 6
    Fortnox
  • 7
    Custom
  • 8
    Twinfield
  • 9
    Sage Accounting
  • 10
    Sage Intacct
  • 11
    Netsuite
export_url string
Response

The URL of the exported purchase order in the external accounting system.

footer object
Response

The footer text template for this purchase order, sourced from the associated document type.

footer_interpolated object
Response

The footer text with template placeholders replaced by actual values from the purchase order.

id integer
Parameter `filter` Parameter `sort`

Unique identifier of this purchase order.

issued_on string
Response Request Parameter `filter` Parameter `sort`

Date when this purchase order was issued.

note object
Response Request

The note or description body of this purchase order.

note_interpolated object
Response

The note text with template placeholders replaced by actual values from the purchase order.

number string
Response Parameter `filter` Parameter `sort`

The auto-generated reference number of this purchase order.

organization organization
Response

The organization this purchase order belongs to.

payment_status_id integer
Response Parameter `filter` Parameter `sort` Enum

The payment status ID indicating how much of this purchase order has been received (1=not received, 2=partially received, 3=fully received).

Enum Values (3 values)

  • 1
    Not received
  • 2
    Partially received
  • 3
    Fully received
project_id integer
Parameter `filter`

ID of the project associated with the deal this purchase order is linked to.

query string
Parameter `filter`

A full-text search query to filter purchase orders by number, subject, or vendor name.

received_on string
Response Parameter `filter` Parameter `sort`

Timestamp when this purchase order was received by the vendor, or null if not yet received.

sent_on string
Response Request Parameter `filter` Parameter `sort`

Date when this purchase order was sent to the vendor.

sent_status integer
Parameter `filter` Parameter `sort` Enum

The sent status of this purchase order, indicating whether it has been sent (1=sent, 2=not sent).

Enum Values (2 values)

  • 1
  • 2
status_id integer
Response Request Parameter `filter` Parameter `sort` Enum

The ID of the approval status of this purchase order (e.g. draft, pending, finalized).

Enum Values (2 values)

  • 1
    Draft
  • 2
    Finalized
subject string
Response Request

The subject line of this purchase order.

subscriber_ids object
Request

Array of IDs of users subscribed to receive notifications about this purchase order.

total_cost object
Response Parameter `filter` Parameter `sort`

The total cost of this purchase order (excluding tax) in the purchase order's currency.

total_cost_default object
Response

The total cost converted to the organization's default currency.

total_cost_normalized object
Response

The total cost converted to the normalized (reporting) currency.

total_cost_with_tax object
Response Parameter `filter` Parameter `sort`

The total cost with tax.

total_cost_with_tax_default object
Response

The total cost with tax default.

total_cost_with_tax_normalized object
Response

The total cost with tax normalized.

total_received object
Response Parameter `filter` Parameter `sort`

The total amount received against this purchase order in the purchase order's currency.

total_received_default object
Response

The total amount received converted to the organization's default currency.

total_received_normalized object
Response

The total amount received converted to the normalized (reporting) currency.

vendor company
Response Parameter `sort`

The vendor (client/company) this purchase order was sent to.

vendor_id integer
Request Parameter `filter` Parameter `sort`

ID of the vendor (client/company) this purchase order was sent to.

Examples

Loading example