Skip to main content
GuidesAPI Reference

List Purchase Orders

GET 
/accounting/purchase-orders

Returns a list of Purchase Orders.

Request​

Query Parameters

    credentialId stringrequired

    The ID of the credential.

    pageNumber int32

    The page number of the results. Default is 1.

    pageSize int32

    The maximum number of results to show on a page. Default is 50. Maximum is 100.

    remoteId string

    Used to filter purchase orders with this third-party application ID.

    purchaseOrderStatus string

    Used to filter purchase orders with the exact purchase order status.

    issueDate string

    Used to filter purchase orders with the exact issue date. Format: YYYY-MM-DD

    purchaseOrderNumber string

    Used to filter purchase orders with the exact purchase order number.

    purchaseOrderNumberContains string

    Used to filter purchase orders whose purchase order numbers contain the provided value.

    purchaseOrderNumberNotEquals string

    Used to filter purchase orders whose purchase order number to exclude.

    deliveryDate string

    Used to filter purchase orders with the exact delivery date. Format: YYYY-MM-DD

    vendorId string

    Used to filter purchase orders with this vendor ID.

    memoContains string

    Used to filter purchase orders whose memos contain the provided value.

    companyId string

    Used to filter purchase orders with this company ID.

    totalAmount float

    Used to filter purchase orders with the exact total amount.

    totalAmountMin float

    Used to filter purchase orders with the minimum total amount.

    totalAmountMax float

    Used to filter purchase orders with the maximum total amount.

    totalAmountNotEquals float

    Used to filter purchase orders whose total amount to exclude.

    remoteCreatedAtMin date

    Used to filter records created after this datetime in the third-party application.

    remoteCreatedAtMax date

    Used to filter records created before this datetime in the third-party application.

    remoteUpdatedAtMin date

    Used to filter records updated after this datetime in the third-party application.

    remoteUpdatedAtMax date

    Used to filter records updated before this datetime in the third-party application.

    createdAtMin date

    Used to filter records created after this datetime.

    createdAtMax date

    Used to filter records created before this datetime.

    updatedAtMin date

    Used to filter records updated after this datetime.

    updatedAtMax date

    Used to filter records updated before this datetime.

Header Parameters

    Authorization stringrequired

    Default value: bearer YOUR_API_KEY

Responses​

200

Schema

    purchaseOrders

    object[]

  • Array [

    • id string
    remoteId string
    purchaseOrderStatus string
    issueDate string
    purchaseOrderNumber string
    deliveryDate

    deliveryAddress

    object

    addressType string
    street1 string
    street2 string
    vendorId string
    accountId string
    memo
    companyId
    totalAmount integer

    Default value: 0

    currency string
    exchangeRate integer

    Default value: 0

    lineItems

    object[]

  • Array [

    • remoteId string
    lineType string
    trackingCategoryIds array
    description string
    accountingItemId string
    totalLineAmount integer

    Default value: 0

  • ]

    • trackingCategoryIds array
    remoteCreatedAt string
    remoteUpdatedAt string
    remoteDeleted boolean

    Default value: true

    createdAt string
    updatedAt string

  • ]

Loading...