Skip to main content
GET
/
billing
/
credit_notes
/
v1
/
{id}
Retrieve a credit note
curl --request GET \
  --url https://api.spacebring.com/billing/credit_notes/v1/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "creditNote": {
    "altCurrencyCode": "<string>",
    "altGrossAmount": 123,
    "altPostPaymentAmount": 123,
    "altPrePaymentAmount": 123,
    "altSubtotalAmount": 123,
    "altTotalAmount": 123,
    "altTotalExcludingTaxAmount": 123,
    "createDate": "2023-11-07T05:31:56Z",
    "creditAmount": 123,
    "currencyCode": "<string>",
    "effectiveDate": "2023-11-07T05:31:56Z",
    "grossAmount": 123,
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "invoiceRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "lines": [
      {
        "altCurrencyCode": "<string>",
        "altGrossAmount": 123,
        "altTotalAmount": 123,
        "altTotalExcludingTaxAmount": 123,
        "altUnitAmount": 123,
        "altUnitExcludingTaxAmount": 123,
        "createDate": "2023-11-07T05:31:56Z",
        "currencyCode": "<string>",
        "discounts": [
          {
            "altAmount": 123,
            "amount": 123,
            "coupon": {
              "amountOff": 123,
              "currencyCode": "<string>",
              "duration": "<string>",
              "durationInMonths": 123,
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "percentOff": 123,
              "type": "<string>"
            },
            "promocode": {
              "code": "<string>",
              "expiration": "2023-11-07T05:31:56Z",
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "limitByFirstPurchase": true
            },
            "subscriptionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ],
        "grossAmount": 123,
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "invoiceItemRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "invoiceRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "memo": "<string>",
        "networkRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "organizationRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "quantity": 123,
        "tax": {
          "altAmount": 123,
          "altTaxableAmount": 123,
          "amount": 123,
          "inclusive": true,
          "rate": 123,
          "taxableAmount": 123
        },
        "totalAmount": 123,
        "totalExcludingTaxAmount": 123,
        "unitAmount": 123,
        "unitExcludingTaxAmount": 123,
        "updateDate": "2023-11-07T05:31:56Z"
      }
    ],
    "memo": "<string>",
    "networkRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "number": "<string>",
    "organizationRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "outOfBandAmount": 123,
    "pdfUrl": "<string>",
    "postPaymentAmount": 123,
    "prePaymentAmount": 123,
    "reason": "duplicate",
    "refunds": [
      {
        "amount": 123,
        "currencyCode": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "paymentMethodLabel": "<string>",
        "transactionRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "status": "<string>",
    "subtotalAmount": 123,
    "taxes": [
      {
        "altAmount": 123,
        "altTaxableAmount": 123,
        "amount": 123,
        "inclusive": true,
        "rate": 123,
        "taxableAmount": 123
      }
    ],
    "title": "<string>",
    "totalAmount": 123,
    "totalExcludingTaxAmount": 123,
    "type": "<string>",
    "updateDate": "2023-11-07T05:31:56Z",
    "voidDate": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

See our authentication documentation for how to authorize your requests

Headers

spacebring-network-id
string<uuid>

The id of the network. Required when using bearer token authentication

Path Parameters

id
string<uuid>
required

The id of the credit note

Response

OK

creditNote
object