Skip to main content
GuidesAPI Reference

List Sales Orders

GET 
/accounting/sales-orders

Returns a list of Purchase Orders.

Request​

Query Parameters

    credentialId stringrequired

    The ID of the credential.

    pageNumber string

    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.

    salesOrderStatus string

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

    issueDate string

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

    salesOrderNumber string

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

    salesOrderNumberContains string

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

    salesOrderNumberNotEquals string

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

    deliveryDate string

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

    customerId string

    Used to filter sales orders with this customer ID.

    memoContains string

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

    companyId string

    Used to filter sales orders with this company ID.

    totalTaxAmount int32

    Overall amount of taxes charged on the sales order.

    totalAmount float

    Used to filter sales orders with the exact total amount.

    totalAmountMin float

    Used to filter sales orders with the minimum total amount.

    totalAmountMax float

    Used to filter purchase orders with the maximum total amount.

    totalAmountNotEquals float

    Used to filter sales 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

    salesOrders

    object[]

  • Array [

    • id string
    remoteId string
    salesOrderStatus
    salesOrderNumber string
    issueDate string
    dueDate string
    paidOnDate
    deliveryDate
    deilveryAddress
    customerId string
    accountId string
    memo
    companyId
    totalTaxAmount
    totalAmount integer

    Default value: 0

    currency string
    exchangeRate integer

    Default value: 0

    totalDiscount
    subTotal

    lineItems

    object[]

  • Array [

    • totalAmount integer

    Default value: 0

    accountingItemId string
    remoteId string

  • ]

    • trackingCategoryIds array
    remoteCreatedAt string
    remoteUpdatedAt string
    remoteDeleted boolean

    Default value: true

    createdAt string
    updatedAt string

  • ]

Loading...