This document is generated by Apidog. Apidog: All-in-one workspace for API design, document, debug, test, mock
This document is generated by Apidog. Apidog: All-in-one workspace for API design, document, debug, test, mock
GET Single Credit Note
Prod Env
{{subdomain}}/api2
Prod Env
{{subdomain}}/api2
GET
{{subdomain}}/api2
Last modified:2025-03-23 23:11:40
Maintainer:Not configured
id: Credit Note ID (required){
"result": "success",
"code": 200,
"data": {
"CreditNote": {
"id": 345,
"number": "CN-2023-001",
"client_id": 15,
"date": "2023-03-22",
"total": 50.00,
"status": 1,
"currency_code": "USD",
"draft": 0,
"notes": "Partial refund for invoice #123",
"created": "2023-03-22 10:15:22",
"modified": "2023-03-22 10:15:22"
// Additional credit note fields...
},
"Client": {
"id": 15,
"name": "ACME Corp",
"business_name": "ACME Corporation",
"email": "billing@acmecorp.com"
// Additional client fields...
},
"InvoiceItem": [
{
"id": 678,
"credit_note_id": 345,
"product_id": 1,
"description": "Premium Widget Return",
"quantity": 1,
"unit_price": 50.00,
"discount": 0,
"tax1": 0.00,
"total": 50.00
// Additional item fields...
}
]
}
}Request
None
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET '{{subdomain}}/api2/api2/credit_notes/{{id}}.json'Response Response Example
200 - Success Response
{
"result": "success",
"code": 200,
"data": {
"CreditNote": {
"id": 345,
"number": "CN-2023-001",
"client_id": 15,
"date": "2023-03-22",
"total": 50.00,
"status": 1,
"currency_code": "USD",
"draft": 0,
"notes": "Partial refund for invoice #123",
"created": "2023-03-22 10:15:22",
"modified": "2023-03-22 10:15:22",
"invoice_id": 123
},
"Client": {
"id": 15,
"name": "ACME Corp",
"business_name": "ACME Corporation",
"email": "billing@acmecorp.com",
"phone1": "555-1234",
"address1": "123 Main St",
"city": "New York",
"state": "NY",
"postal_code": "10001",
"country_code": "US"
},
"InvoiceItem": [
{
"id": 678,
"credit_note_id": 345,
"product_id": 1,
"description": "Premium Widget Return",
"quantity": 1,
"unit_price": 50.00,
"discount": 0,
"tax1": 0.00,
"total": 50.00
}
]
}
}Modified at 2025-03-23 23:11:40