Skip to main content
GET
/
billing
/
credit_notes
/
v1
Retrieve credit notes
curl --request GET \
  --url https://api.spacebring.com/billing/credit_notes/v1 \
  --header 'Authorization: Basic <encoded-value>'
{
  "creditNotes": [
    {
      "baseAmounts": {
        "currencyCode": "<string>",
        "postPaymentAmount": 123,
        "prePaymentAmount": 123,
        "subtotalAmount": 123,
        "subtotalAmountExcludingTax": 123,
        "taxes": [
          {
            "amount": 123,
            "inclusive": true,
            "rate": 123,
            "taxableAmount": 123
          }
        ],
        "totalAmount": 123,
        "totalExcludingTaxAmount": 123
      },
      "createDate": "2023-11-07T05:31:56Z",
      "creditAmount": 123,
      "currencyCode": "<string>",
      "effectiveDate": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "invoiceRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "internalNote": "<string>",
      "lines": [
        {
          "baseAmounts": {
            "currencyCode": "<string>",
            "discountedAmount": 123,
            "tax": {
              "amount": 123,
              "inclusive": true,
              "rate": 123,
              "taxableAmount": 123
            },
            "totalAmount": 123,
            "totalExcludingTaxAmount": 123,
            "unitAmount": 123,
            "unitExcludingTaxAmount": 123
          },
          "createDate": "2023-11-07T05:31:56Z",
          "currencyCode": "<string>",
          "discountedAmount": 123,
          "discounts": [
            {
              "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"
            }
          ],
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "invoiceItemRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "invoiceRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "locationRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "networkRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "quantity": 123,
          "tax": {
            "amount": 123,
            "inclusive": true,
            "rate": 123,
            "taxableAmount": 123
          },
          "totalAmount": 123,
          "totalExcludingTaxAmount": 123,
          "unitAmount": 123,
          "unitExcludingTaxAmount": 123,
          "updateDate": "2023-11-07T05:31:56Z"
        }
      ],
      "locationRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "networkRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "number": "<string>",
      "outOfBandAmount": 123,
      "pdfUrl": "<string>",
      "postPaymentAmount": 123,
      "prePaymentAmount": 123,
      "reason": "duplicate",
      "refunds": [
        {
          "amount": 123,
          "currencyCode": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "method": {
            "label": "<string>",
            "type": "external"
          },
          "transactionRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      ],
      "status": "<string>",
      "subtotalAmount": 123,
      "subtotalAmountExcludingTax": 123,
      "taxes": [
        {
          "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"
    }
  ],
  "nextPageToken": "<string>",
  "searchQueryNext": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://www.spacebring.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

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

Query Parameters

​
invoiceRef
string<uuid>

The id of the invoice. One of invoiceRef or locationRef is required.

​
locationRef
string<uuid>

The id of the location. One of invoiceRef or locationRef is required.

​
limit
integer
default:25

The maximum number of items to return (max 100, default 25)

Required range: 1 <= x <= 100
​
nextPageToken
string

Token for pagination to get the next page of results

Response

OK

​
creditNotes
object[]
​
nextPageToken
string

Token to retrieve the next page of results

​
searchQueryNext
string

Full query string for the next page