Credit Notes
Get Credit Note
GET
/
credit-notes
/
{id}
curl https://api.alguna.io/credit-notes/cn_xyz789 \
-H "Authorization: Bearer YOUR_API_KEY"
const creditNote = await alguna.creditNotes.get('cn_xyz789');
{
"id": "cn_xyz789",
"accountId": "acc_abc123",
"invoiceId": "inv_def456",
"status": "issued",
"applyDate": "2024-01-20T10:00:00Z",
"creditDate": "2024-01-20T10:00:00Z",
"currency": "USD",
"description": "Service credit for downtime",
"lineItems": [
{
"description": "Service credit",
"unitPrice": "100.00",
"quantity": "1",
"total": "100.00"
}
],
"subtotal": "100.00",
"tax": "0.00",
"total": "100.00",
"isPdfAvailable": true,
"createdAt": "2024-01-20T10:00:00Z",
"updatedAt": "2024-01-20T12:00:00Z"
}
Retrieve a credit note by its ID.
string
required
The credit note ID.
curl https://api.alguna.io/credit-notes/cn_xyz789 \
-H "Authorization: Bearer YOUR_API_KEY"
const creditNote = await alguna.creditNotes.get('cn_xyz789');
{
"id": "cn_xyz789",
"accountId": "acc_abc123",
"invoiceId": "inv_def456",
"status": "issued",
"applyDate": "2024-01-20T10:00:00Z",
"creditDate": "2024-01-20T10:00:00Z",
"currency": "USD",
"description": "Service credit for downtime",
"lineItems": [
{
"description": "Service credit",
"unitPrice": "100.00",
"quantity": "1",
"total": "100.00"
}
],
"subtotal": "100.00",
"tax": "0.00",
"total": "100.00",
"isPdfAvailable": true,
"createdAt": "2024-01-20T10:00:00Z",
"updatedAt": "2024-01-20T12:00:00Z"
}
⌘I
curl https://api.alguna.io/credit-notes/cn_xyz789 \
-H "Authorization: Bearer YOUR_API_KEY"
const creditNote = await alguna.creditNotes.get('cn_xyz789');
{
"id": "cn_xyz789",
"accountId": "acc_abc123",
"invoiceId": "inv_def456",
"status": "issued",
"applyDate": "2024-01-20T10:00:00Z",
"creditDate": "2024-01-20T10:00:00Z",
"currency": "USD",
"description": "Service credit for downtime",
"lineItems": [
{
"description": "Service credit",
"unitPrice": "100.00",
"quantity": "1",
"total": "100.00"
}
],
"subtotal": "100.00",
"tax": "0.00",
"total": "100.00",
"isPdfAvailable": true,
"createdAt": "2024-01-20T10:00:00Z",
"updatedAt": "2024-01-20T12:00:00Z"
}