Sync a value receipt | Paid

Find or create a value receipt by natural key (customer + product/order + dates), then populate it with current data inline. Returns the ID, status, and public URL. Posted (sealed) VRs are returned as-is without re-populating.

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Request

Body

startDatedatetimeRequired

endDatedatetimeRequired

customerIdstringOptional>=1 character

Mutually exclusive with externalCustomerId. Exactly one is required.

externalCustomerIdstringOptional>=1 character

Mutually exclusive with customerId. Exactly one is required.

productobjectOptional

Mutually exclusive with orderId. Provide at most one.

orderIdstringOptional>=1 character

Mutually exclusive with product. Provide at most one.

Response

200

idstring

statusstring

publicUrlTokenstring

publicUrlstringformat: "uri"

Errors

400

Bad Request Error

404

Not Found Error

500

Internal Server Error

1	const url = 'https://api.agentpaid.io/api/v2/value-receipts/sync';
2	const options = {
3	method: 'POST',
4	headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5	body: '{"startDate":"2024-01-01T00:00:00Z","endDate":"2024-01-31T23:59:59Z"}'
6	};
7
8	try {
9	const response = await fetch(url, options);
10	const data = await response.json();
11	console.log(data);
12	} catch (error) {
13	console.error(error);
14	}

1	{
2	"id": "vr_9f8b7c6d5e4a3b2c1d0e",
3	"status": "active",
4	"publicUrlToken": "abc123xyz789",
5	"publicUrl": "https://value-receipts.agentpaid.io/abc123xyz789"
6	}