Create payment allocations

POST

https://api.agentpaid.io/api/v2/payment-allocations/

POST

/api/v2/payment-allocations/

1 import { PaidClient } from "@paid-ai/paid-node";
2 
3 async function main() {
4     const client = new PaidClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.paymentAllocations.createPaymentAllocation({
8         paymentId: "pay_9f8b7c6d",
9         allocations: [
10             {
11                 invoiceLineId: "line_4a3b2c1d",
12                 amount: 15000,
13             },
14         ],
15     });
16 }
17 main();

1 {
2   "data": [
3     {
4       "id": "alloc_7e6d5c4b",
5       "paymentId": "pay_9f8b7c6d",
6       "invoiceId": "inv_1a2b3c4d",
7       "invoiceLineId": "line_4a3b2c1d",
8       "amount": 15000,
9       "currency": "USD",
10       "type": "allocated",
11       "status": "posted",
12       "allocationDate": "2024-01-15T09:30:00Z",
13       "createdAt": "2024-01-15T09:30:00Z"
14     }
15   ]
16 }

Allocates a payment across one or more invoice lines. When an invoice becomes fully paid, its credit entitlements are processed.

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Request

Body

paymentIdstringRequired>=1 character

The payment to allocate from.

allocationslist of objectsRequired

Invoice lines to allocate the payment to.

Response

201

datalist of objects

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error