Skip to main content
GuidesAPI Reference

Update Purchase Order

PUT 
/accounting/purchase-orders/:id

Update a Purchase Order with the given id.

Request​

Path Parameters

    id stringrequired

    The ID of the purchase order.

Query Parameters

    credentialId stringrequired

    The ID of the credential.

Header Parameters

    Authorization stringrequired

    Default value: bearer YOUR_API_KEY

Body

    vendorId string

    Identifier for the vendor or supplier from whom the goods or services are being ordered.

    accountId string

    Identifier for the account where the expenses related to the purchase order will be recorded.

    lineItems

    object

    required

    Detailed list of all goods or services ordered, typically including descriptions, quantities, and prices.

    description stringrequired

    A concise detail or overview of the specific good or service listed in the line item.

    unitPrice float

    The cost assigned per individual unit of the item or service.

    quantity int32

    The number of units of the specific good or service being ordered.

    accountingItemId string

    The ID of the item associated with the purchase order line item.

    totalLineAmount floatrequired

    The cumulative sum for the line item, typically calculated as unitPrice * quantity plus any tax.

    purchaseOrderStatus string

    The current standing or condition of the purchase order. Possible values: OPEN, DRAFT, SUBMITTED, AUTHORIZED, BILLED, CLOSED, DELETED Quickbooks Online: OPEN, CLOSED

    issueDate string

    The date when the purchase order was created and issued to the vendor. Format: YYYY-MM-DD

    purchaseOrderNumber string

    A unique number or code assigned to the purchase order for tracking and reference purposes.

    deliveryAddress

    object

    The physical address where the ordered items are to be delivered.

    addressType stringrequired

    The address type. Possible value: BILLING, SHIPPING.

    street1 stringrequired

    Line 1 of the address's street.

    street2 string

    Line 2 of the address's street.

    city string

    The address's city.

    state string

    The address's state or region.

    countrySubdivision string

    The address's state or region.

    country string

    The address's country. Possible values: AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IL, IT, JM, JP, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, MK, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, SH, KN, LC, PM, VC, WS, SM, ST, SA, SN, SC, SL, SG, SK, SI, SB, SO, ZA, GS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW, AX, BQ, CW, GG, IM, JE, ME, BL, MF, RS, SX, SS, XK

    zipCode string

    The address's zip code.

    memo string

    Additional notes, comments, or details pertinent to the purchase order.

    totalAmount float

    The full sum of the purchase order, considering all line items and any other charges.

    currency string

    The type of currency in which the purchase order's amount is presented. Possible values: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, UYI, UYU, UYW, UZS, VES, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWL

    exchangeRate float

    The conversion rate applied if the purchase order involves transactions in a foreign currency.

    remoteFields json

    An object containing remote fields that are not supported by the common model. The keys are the names of the fields of the corresponding resource in the remote app, and the values can be strings, numbers, arrays or objects.

Responses​

200

Schema

    purchaseOrder

    object

    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...