Create Vendor
POST/accounting/vendors
Create a Vendor.
Request
Query Parameters
The ID of the credential.
Header Parameters
Default value: bearer YOUR_API_KEY
- application/json
Body
The full name or designation by which the vendor is identified.
The primary electronic mail address used for communication with the vendor.
A unique identifier related to the vendor, often used for billing purposes, such as a VAT number.
The current standing or condition of the vendor. Possible values: ACTIVE, ARCHIVED
The preferred currency for transactions involving this vendor. 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
ID of the company the vendor belongs to.
addresses
object
Physical locations or postal addresses associated with the vendor.
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.
phoneNumbers
object
Contact numbers for the vendor, which could include mobile, work, or home numbers.
The phone number type. Possible value: PRIMARY, OTHER, MOBILE, FAX
The phone number.
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 [
]
Array [
]
vendor
object
addresses
object[]
phoneNumbers
object[]
Default value: true
{
"vendor": {
"id": "00000000-0000-0000-0000-000000000000",
"remoteId": "41",
"vendorName": "Hicks Hardware",
"email": {},
"taxNumber": {},
"vendorStatus": "ACTIVE",
"currency": "USD",
"companyId": {},
"addresses": [
{
"zipCode": "94303",
"street1": "42 Main St.",
"state": "CA",
"city": "Middlefield",
"addressType": "Billing",
"countrySubdivision": "CA"
}
],
"phoneNumbers": [
{
"phoneNumberType": "Primary",
"phoneNumber": "(650) 554-1973"
}
],
"remoteCreatedAt": "2023-11-19T17:00:17.000Z",
"remoteUpdatedAt": "2023-11-19T17:00:17.000Z",
"remoteDeleted": false,
"createdAt": "2024-02-22T11:17:53.264Z",
"updatedAt": "2024-02-22T13:54:03.445Z"
}
}
{
"vendor": {
"id": "00000000-0000-0000-0000-000000000000",
"remoteId": "41",
"vendorName": "Hicks Hardware",
"email": null,
"taxNumber": null,
"vendorStatus": "ACTIVE",
"currency": "USD",
"companyId": null,
"addresses": [
{
"zipCode": "94303",
"street1": "42 Main St.",
"state": "CA",
"city": "Middlefield",
"addressType": "Billing",
"countrySubdivision": "CA"
}
],
"phoneNumbers": [
{
"phoneNumberType": "Primary",
"phoneNumber": "(650) 554-1973"
},
{
"phoneNumberType": "Mobile",
"phoneNumber": "(650) 445-6666"
}
],
"remoteCreatedAt": "2023-11-19T17:00:17.000Z",
"remoteUpdatedAt": "2023-11-19T17:00:17.000Z",
"remoteDeleted": false,
"createdAt": "2024-02-22T11:17:53.264Z",
"updatedAt": "2024-02-22T13:54:03.445Z"
}
}
400
- application/json
- Schema
- Example (from schema)
- Result
Schema
{}
{}