Retrieve a credit note's balance items

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/credit_notes/cn_8a1d2c3b4e5f4a6b9c7d0e1f2a3b4c5d/items" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.creditNotes.getCreditNoteItems('cn_8a1d2c3b4e5f4a6b9c7d0e1f2a3b4c5d');
console.log(response.data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.credit_notes.credit_notes_dto.CreditNotesDto.CreditNoteItems;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<CreditNoteItems> response = client.creditNotes().getCreditNoteItems("cn_8a1d2c3b4e5f4a6b9c7d0e1f2a3b4c5d");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.CreditNotes.GetCreditNoteItemsAsync("cn_8a1d2c3b4e5f4a6b9c7d0e1f2a3b4c5d");

Console.WriteLine(response.Json);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.CreditNotes().GetCreditNoteItems(context.Background(), "cn_8a1d2c3b4e5f4a6b9c7d0e1f2a3b4c5d", nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "credit_note": {
    "href": "<string>",
    "items": [
      {
        "credit_note_from_blank_method": "<string>",
        "credit_note_from_credit_note": "<string>",
        "credit_note_from_gift_certificate": "<string>",
        "credit_note_from_invoice_credit": "<string>",
        "credit_note_from_payment_method": "<string>",
        "credit_note_total": "<string>",
        "invoice": "<unknown>",
        "object": "<string>",
        "refund_from_blank_method": "<string>",
        "refund_from_credit_note": "<string>",
        "refund_from_gift_certificate": "<string>",
        "refund_from_invoice_credit": "<string>",
        "refund_from_payment_method": "<string>",
        "refund_total": "<string>"
      }
    ],
    "object": "<string>"
  }
}

GET

credit_notes

{credit_note_id}

items

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/credit_notes/cn_8a1d2c3b4e5f4a6b9c7d0e1f2a3b4c5d/items" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.creditNotes.getCreditNoteItems('cn_8a1d2c3b4e5f4a6b9c7d0e1f2a3b4c5d');
console.log(response.data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.credit_notes.credit_notes_dto.CreditNotesDto.CreditNoteItems;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<CreditNoteItems> response = client.creditNotes().getCreditNoteItems("cn_8a1d2c3b4e5f4a6b9c7d0e1f2a3b4c5d");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.CreditNotes.GetCreditNoteItemsAsync("cn_8a1d2c3b4e5f4a6b9c7d0e1f2a3b4c5d");

Console.WriteLine(response.Json);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.CreditNotes().GetCreditNoteItems(context.Background(), "cn_8a1d2c3b4e5f4a6b9c7d0e1f2a3b4c5d", nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "credit_note": {
    "href": "<string>",
    "items": [
      {
        "credit_note_from_blank_method": "<string>",
        "credit_note_from_credit_note": "<string>",
        "credit_note_from_gift_certificate": "<string>",
        "credit_note_from_invoice_credit": "<string>",
        "credit_note_from_payment_method": "<string>",
        "credit_note_total": "<string>",
        "invoice": "<unknown>",
        "object": "<string>",
        "refund_from_blank_method": "<string>",
        "refund_from_credit_note": "<string>",
        "refund_from_gift_certificate": "<string>",
        "refund_from_invoice_credit": "<string>",
        "refund_from_payment_method": "<string>",
        "refund_total": "<string>"
      }
    ],
    "object": "<string>"
  }
}

Fetches the credit note’s balance rows under credit_note.items. Each row splits the credit and refund totals by source, such as payment method, gift certificate or invoice credit, each amount a string. This is not a paged listing.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization

string

header

required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

credit_note_id

string

required

The credit note's id, which starts with cn_.

Response

200 - application/json

The balance rows, under credit_note.items.

credit_note

object

Show child attributes

Guides

API reference

Retrieve a credit note's balance items

Authorizations

Path Parameters

Response