Create Sales Order
POST/accounting/sales-orders
Create a Purchase Order.
Request
Query Parameters
The ID of the credential.
Header Parameters
Default value: bearer YOUR_API_KEY
- application/json
Body
Identifier for the customer or supplier from whom the goods or services are being ordered.
Identifier for the account where the expenses related to the sale order will be recorded.
lineItems
object
required
Detailed list of all goods or services ordered, typically including descriptions, quantities, and prices.
A concise detail or overview of the specific good or service listed in the line item.
The cost assigned per individual unit of the item or service.
The number of units of the specific good or service being ordered.
The ID of the item associated with the purchase order line item.
The cumulative sum for the line item, typically calculated as unitPrice * quantity plus any tax.
The current standing or condition of the sales order. Possible values: OPEN, DRAFT, SUBMITTED, AUTHORIZED, BILLED, CLOSED, DELETED Quickbooks Online: OPEN, CLOSED
The date when the sale order was created and issued to the vendor. Format: YYYY-MM-DD
A unique number or code assigned to the sale order for tracking and reference purposes.
deliveryAddress
object
The physical address where the ordered items are to be delivered.
The address type. Possible value: BILLING, SHIPPING.
Line 1 of the address's street.
Line 2 of the address's street.
The address's city.
The address's state or region.
The address's state or region.
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
The address's zip code.
Additional notes, comments, or details pertinent to the sale order.
The full sum of the sale order, considering all line items and any other charges.
The type of currency in which the sale 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
The conversion rate applied if the sale order involves transactions in a foreign currency.
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
- 400
200
- application/json
- Schema
- Example (from schema)
- Result
Schema
Array [
]
salesOrder
object
Default value: 0
Default value: 0
lineItems
object[]
Default value: 0
Default value: true
{
"salesOrder": {
"id": "00000000-0000-0000-0000-000000000000",
"remoteId": "361",
"salesOrderStatus": {},
"salesOrderNumber": "SO117",
"issueDate": "2023-10-10",
"dueDate": "2023-10-10",
"paidOnDate": {},
"deliveryDate": {},
"deilveryAddress": {},
"customerId": "00000000-0000-0000-0000-000000000000",
"accountId": "00000000-0000-0000-0000-000000000000",
"memo": {},
"companyId": {},
"totalTaxAmount": {},
"totalAmount": 100,
"currency": "USD",
"exchangeRate": 1,
"totalDiscount": {},
"subTotal": {},
"lineItems": [
{
"totalAmount": 100,
"accountingItemId": "00000000-0000-0000-0000-000000000000",
"remoteId": "1"
}
],
"trackingCategoryIds": [
null
],
"remoteCreatedAt": "2023-10-29T06:52:05.000Z",
"remoteUpdatedAt": "2023-10-29T06:52:05.000Z",
"remoteDeleted": false,
"createdAt": "2024-02-22T11:17:23.939Z",
"updatedAt": "2024-02-22T13:53:08.847Z"
}
}
{
"salesOrder": {
"id": "00000000-0000-0000-0000-000000000000",
"remoteId": "361",
"salesOrderStatus": null,
"salesOrderNumber": "SO117",
"issueDate": "2023-10-10",
"dueDate": "2023-10-10",
"paidOnDate": null,
"deliveryDate": null,
"deilveryAddress": null,
"customerId": "00000000-0000-0000-0000-000000000000",
"accountId": "00000000-0000-0000-0000-000000000000",
"memo": null,
"companyId": null,
"totalTaxAmount": null,
"totalAmount": 100,
"currency": "USD",
"exchangeRate": 1,
"totalDiscount": null,
"subTotal": null,
"lineItems": [
{
"totalAmount": 100,
"accountingItemId": "00000000-0000-0000-0000-000000000000",
"remoteId": "1"
},
{
"totalAmount": 100
}
],
"trackingCategoryIds": [],
"remoteCreatedAt": "2023-10-29T06:52:05.000Z",
"remoteUpdatedAt": "2023-10-29T06:52:05.000Z",
"remoteDeleted": false,
"createdAt": "2024-02-22T11:17:23.939Z",
"updatedAt": "2024-02-22T13:53:08.847Z"
}
}
400
- application/json
- Schema
- Example (from schema)
- Result
Schema
{}
{}