{
"id": 1,
"creditNoteDate": "2023-01-01T00:00:00Z",
"creditNoteNumber": "CN-001",
"referenceNo": "REF-001",
"customerId": 1,
"exchangeRate": 1,
"currencyCode": "USD",
"note": "Thank you for your business",
"termsConditions": "Valid for 30 days",
"isOpen": true,
"isClosed": false,
"entries": [
{
"index": 1,
"itemId": 1,
"rate": 1,
"quantity": 1,
"discount": 1,
"discountType": "percentage",
"description": "This is a description",
"taxCode": "123456",
"taxRateId": 1,
"warehouseId": 1,
"projectId": 1,
"projectRefId": 1,
"projectRefType": "TASK",
"projectRefInvoicedAmount": 100,
"sellAccountId": 1020,
"costAccountId": 1021
}
],
"warehouseId": 1,
"branchId": 1,
"attachments": [
{}
],
"discount": 10,
"discountType": "percentage",
"adjustment": 5,
"pdfTemplateId": 1,
"creditsRemaining": 100,
"creditsUsed": 50,
"subtotal": 900,
"subtotalLocal": 900,
"discountAmount": 10,
"discountAmountLocal": 10,
"discountPercentage": 10,
"adjustmentLocal": 5,
"total": 1000,
"totalLocal": 1000,
"createdAt": "2023-01-01T00:00:00Z",
"updatedAt": "2023-01-02T00:00:00Z",
"formattedCreditNoteDate": "2023-01-01",
"formattedCreatedAt": "2023-01-01",
"formattedAmount": "$1,000.00",
"formattedCreditsRemaining": "$100.00",
"formattedCreditsUsed": "$50.00",
"formattedSubtotal": "$900.00",
"discountAmountFormatted": "$10.00",
"discountAmountLocalFormatted": "$10.00",
"discountPercentageFormatted": "10%",
"adjustmentFormatted": "$5.00",
"adjustmentLocalFormatted": "$5.00",
"totalFormatted": "$1,000.00",
"totalLocalFormatted": "$1,000.00"
}
{
"id": 1,
"creditNoteDate": "2023-01-01T00:00:00Z",
"creditNoteNumber": "CN-001",
"referenceNo": "REF-001",
"customerId": 1,
"exchangeRate": 1,
"currencyCode": "USD",
"note": "Thank you for your business",
"termsConditions": "Valid for 30 days",
"isOpen": true,
"isClosed": false,
"entries": [
{
"index": 1,
"itemId": 1,
"rate": 1,
"quantity": 1,
"discount": 1,
"discountType": "percentage",
"description": "This is a description",
"taxCode": "123456",
"taxRateId": 1,
"warehouseId": 1,
"projectId": 1,
"projectRefId": 1,
"projectRefType": "TASK",
"projectRefInvoicedAmount": 100,
"sellAccountId": 1020,
"costAccountId": 1021
}
],
"warehouseId": 1,
"branchId": 1,
"attachments": [
{}
],
"discount": 10,
"discountType": "percentage",
"adjustment": 5,
"pdfTemplateId": 1,
"creditsRemaining": 100,
"creditsUsed": 50,
"subtotal": 900,
"subtotalLocal": 900,
"discountAmount": 10,
"discountAmountLocal": 10,
"discountPercentage": 10,
"adjustmentLocal": 5,
"total": 1000,
"totalLocal": 1000,
"createdAt": "2023-01-01T00:00:00Z",
"updatedAt": "2023-01-02T00:00:00Z",
"formattedCreditNoteDate": "2023-01-01",
"formattedCreatedAt": "2023-01-01",
"formattedAmount": "$1,000.00",
"formattedCreditsRemaining": "$100.00",
"formattedCreditsUsed": "$50.00",
"formattedSubtotal": "$900.00",
"discountAmountFormatted": "$10.00",
"discountAmountLocalFormatted": "$10.00",
"discountPercentageFormatted": "10%",
"adjustmentFormatted": "$5.00",
"adjustmentLocalFormatted": "$5.00",
"totalFormatted": "$1,000.00",
"totalLocalFormatted": "$1,000.00"
}
Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token.
"Bearer bc_1234567890abcdef"
Required if Authorization is a JWT token. The organization ID to operate within.
Credit note ID
Returns the credit note
The response is of type object
.