Record a vendor prepayment
curl --request POST \
--url https://api.arcuserp.com/v1/vendors/{id}/prepayments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 5000,
"payment_method": "check",
"payment_date": "2026-05-14",
"note": "PO 4821 advance -- 50% deposit required by vendor"
}
'import requests
url = "https://api.arcuserp.com/v1/vendors/{id}/prepayments"
payload = {
"amount": 5000,
"payment_method": "check",
"payment_date": "2026-05-14",
"note": "PO 4821 advance -- 50% deposit required by vendor"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 5000,
payment_method: 'check',
payment_date: '2026-05-14',
note: 'PO 4821 advance -- 50% deposit required by vendor'
})
};
fetch('https://api.arcuserp.com/v1/vendors/{id}/prepayments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.arcuserp.com/v1/vendors/{id}/prepayments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amount' => 5000,
'payment_method' => 'check',
'payment_date' => '2026-05-14',
'note' => 'PO 4821 advance -- 50% deposit required by vendor'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.arcuserp.com/v1/vendors/{id}/prepayments"
payload := strings.NewReader("{\n \"amount\": 5000,\n \"payment_method\": \"check\",\n \"payment_date\": \"2026-05-14\",\n \"note\": \"PO 4821 advance -- 50% deposit required by vendor\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.arcuserp.com/v1/vendors/{id}/prepayments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 5000,\n \"payment_method\": \"check\",\n \"payment_date\": \"2026-05-14\",\n \"note\": \"PO 4821 advance -- 50% deposit required by vendor\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcuserp.com/v1/vendors/{id}/prepayments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 5000,\n \"payment_method\": \"check\",\n \"payment_date\": \"2026-05-14\",\n \"note\": \"PO 4821 advance -- 50% deposit required by vendor\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"prepayment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prepayment_number": "VPREP-0000001",
"amount": 123,
"applied_amount": 123,
"balance": 123,
"status": "active",
"payment_method": "<string>",
"payment_date": "2023-11-07T05:31:56Z",
"journal_entry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}Purchasing
Record a vendor prepayment
Records a pre-bill advance payment to a vendor. The prepayment is booked as an asset (GL 1440 Vendor Prepayments Asset) rather than reducing AP, because no bill has been received yet. This mirrors NetSuite Vendor Prepayment / Acumatica Prepayment documents.
GL entry posted (atomic, single transaction):
DR Vendor Prepayments Asset (1440) <amount>
CR Cash / Bank (payment-method-resolved) <amount>
Mode guard: the entity setting enable_vendor_prepayments_asset_posting must be true.
Returns HTTP 422 prepayment_mode_disabled otherwise.
Idempotency: pass Idempotency-Key header (UUID) to make the call safe to retry.
Repeated calls with the same key return the original response without re-posting the JE.
Period lock: posting to a locked tax year returns HTTP 422 tax_year_locked.
Requires ap:write scope.
POST
/
vendors
/
{id}
/
prepayments
Record a vendor prepayment
curl --request POST \
--url https://api.arcuserp.com/v1/vendors/{id}/prepayments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 5000,
"payment_method": "check",
"payment_date": "2026-05-14",
"note": "PO 4821 advance -- 50% deposit required by vendor"
}
'import requests
url = "https://api.arcuserp.com/v1/vendors/{id}/prepayments"
payload = {
"amount": 5000,
"payment_method": "check",
"payment_date": "2026-05-14",
"note": "PO 4821 advance -- 50% deposit required by vendor"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 5000,
payment_method: 'check',
payment_date: '2026-05-14',
note: 'PO 4821 advance -- 50% deposit required by vendor'
})
};
fetch('https://api.arcuserp.com/v1/vendors/{id}/prepayments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.arcuserp.com/v1/vendors/{id}/prepayments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amount' => 5000,
'payment_method' => 'check',
'payment_date' => '2026-05-14',
'note' => 'PO 4821 advance -- 50% deposit required by vendor'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.arcuserp.com/v1/vendors/{id}/prepayments"
payload := strings.NewReader("{\n \"amount\": 5000,\n \"payment_method\": \"check\",\n \"payment_date\": \"2026-05-14\",\n \"note\": \"PO 4821 advance -- 50% deposit required by vendor\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.arcuserp.com/v1/vendors/{id}/prepayments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 5000,\n \"payment_method\": \"check\",\n \"payment_date\": \"2026-05-14\",\n \"note\": \"PO 4821 advance -- 50% deposit required by vendor\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcuserp.com/v1/vendors/{id}/prepayments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 5000,\n \"payment_method\": \"check\",\n \"payment_date\": \"2026-05-14\",\n \"note\": \"PO 4821 advance -- 50% deposit required by vendor\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"prepayment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prepayment_number": "VPREP-0000001",
"amount": 123,
"applied_amount": 123,
"balance": 123,
"status": "active",
"payment_method": "<string>",
"payment_date": "2023-11-07T05:31:56Z",
"journal_entry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}Authorizations
API key issued per entity via Settings > Developers > API Keys.
Each key carries scopes (e.g. orders:read, products:write).
Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.
Headers
Optional idempotency key. Re-POST with same key returns cached 201 without re-processing.
Path Parameters
Vendor account UUID (account_type must be 'vendor').
Body
application/json
Prepayment amount in entity currency. Must be > 0.
Required range:
x >= 0.01Tender method used for the advance payment.
Available options:
cash, check, card, ach, external, wire, other Effective date for the journal entry. Defaults to today if omitted.
Optional free-text note (reference number, reason for advance, etc.).
Optional reference to an account_payment_methods row.
Optional bank account reference for ACH / wire payments.
Alternative idempotency key in body (header takes precedence).
Response
Vendor prepayment recorded
Show child attributes
Show child attributes
Was this page helpful?