Developer
Documentation
Resources
Get Support
Sign in
Developer
Get Support
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Developer
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
  • Products
  • Offerings
  • PricingPlans
  • Invoices
  • InvoiceGroups
  • Orders
  • Quotes
  • Entitlements
  • Other operations
Platform
Commerce / Reference / REST API

Other operations

Postman Collection
OpenAPI
GET

Get credit note by ID

Retrieve credit note by id

Rate limit: 3600 requests per minute.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

id

string

Required

Header parameters

X-transaction-account

string

Required

Responses

OK

application/json

Ar_CreditNotePublicDto
GET/v2/credit-notes/{id}
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/commerce/api/v2/credit-notes/{id}' \ --header 'Accept: application/json' \ --header 'X-transaction-account: <X-transaction-account>'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 { "id": "<string>", "number": "<string>", "memo": "<string>", "reason": "refund_wrong_order_repurchase", "type": "full-item-refund", "invoice": "<string>", "currency": "USD", "items": [ { "id": "<string>", "entitlementId": "<string>", "subtotal": 2154, "refundToCustomerBalance": 2154, "tax": 2154, "taxPercent": 2154, "total": 2154, "invoiceItems": [ "<string>" ], "taxItems": [ { "id": "<string>", "tax": 2154, "taxPercent": 2154, "taxId": "<string>", "taxAmountLabel": "<string>", "taxIdLabel": "<string>" } ], "creditObj": { "externalId": "<string>", "amount": 2154, "breachPeriod": { "startAt": 31, "endAt": 31 } }, "metadata": { "parentItemId": "<string>", "type": "ADMIN_FEE", "feeDetails": {} } } ], "status": "PENDING", "refundId": "<string>", "rechargeInvoiceId": "<string>", "createdAt": 31, "updatedAt": 31, "purchaseOrderNumber": "<string>", "additionalNotes": "<string>", "arn": "<string>" }

Rate this page: