cURL
curl -X GET "$EXSITED_BASE_URL/api/v4/purchase_credit_notes/pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b" \
-H "Authorization: Bearer $ACCESS_TOKEN"from exsited import build_client
client = build_client()
response = client.purchase_credit_notes.get_purchase_credit_note(
"pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b"
)
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.purchaseCreditNotes.getPurchaseCreditNote('pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b');
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->purchaseCreditNotes->getPurchaseCreditNote(
'pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b',
);
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.purchase_credit_notes.purchase_credit_notes_dto.PurchaseCreditNotesDto.PurchaseCreditNoteRead;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<PurchaseCreditNoteRead> response = client.purchaseCreditNotes().getPurchaseCreditNote(
"pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b");
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.PurchaseCreditNotes.GetPurchaseCreditNoteAsync("pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b");
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.purchaseCreditNotes.getPurchaseCreditNote(
'pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b',
);
print(response.map);
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.PurchaseCreditNotes().GetPurchaseCreditNote(context.Background(), "pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b", nil, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"purchase_credit_note": {
"account": {
"code": "<string>",
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>"
},
"code": "<string>",
"created_by": {
"name": "<string>",
"object": "<string>"
},
"created_on": "<string>",
"currency": {
"code": "<string>",
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>"
},
"href": "<string>",
"id": "<string>",
"initial_amount": "<string>",
"issue_date": "<string>",
"last_updated_by": {
"name": "<string>",
"object": "<string>"
},
"last_updated_on": "<string>",
"object": "<string>",
"purchase_credit_note_rows": [
{
"credit_note_from_blank_method": "<string>",
"credit_note_from_credit_note": "<string>",
"credit_note_from_payment_method": "<string>",
"credit_note_total": "<string>",
"payment_method": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"payment_processor": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"refund_from_blank_method": "<string>",
"refund_from_credit_note": "<string>",
"refund_from_payment_method": "<string>",
"refund_total": "<string>"
}
],
"purchase_payment": {
"code": "<string>",
"href": "<string>",
"id": "<string>",
"object": "<string>"
},
"refund_amount": "<string>",
"refundable": true,
"remaining_amount": "<string>",
"status": "<unknown>",
"version": 123
}
}Purchase credit notes
Retrieve a purchase credit note
Returns one purchase credit note under purchase_credit_note.
GET
/
purchase_credit_notes
/
{purchase_credit_note_id}
cURL
curl -X GET "$EXSITED_BASE_URL/api/v4/purchase_credit_notes/pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b" \
-H "Authorization: Bearer $ACCESS_TOKEN"from exsited import build_client
client = build_client()
response = client.purchase_credit_notes.get_purchase_credit_note(
"pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b"
)
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.purchaseCreditNotes.getPurchaseCreditNote('pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b');
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->purchaseCreditNotes->getPurchaseCreditNote(
'pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b',
);
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.purchase_credit_notes.purchase_credit_notes_dto.PurchaseCreditNotesDto.PurchaseCreditNoteRead;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<PurchaseCreditNoteRead> response = client.purchaseCreditNotes().getPurchaseCreditNote(
"pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b");
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.PurchaseCreditNotes.GetPurchaseCreditNoteAsync("pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b");
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.purchaseCreditNotes.getPurchaseCreditNote(
'pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b',
);
print(response.map);
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.PurchaseCreditNotes().GetPurchaseCreditNote(context.Background(), "pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b", nil, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"purchase_credit_note": {
"account": {
"code": "<string>",
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>"
},
"code": "<string>",
"created_by": {
"name": "<string>",
"object": "<string>"
},
"created_on": "<string>",
"currency": {
"code": "<string>",
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>"
},
"href": "<string>",
"id": "<string>",
"initial_amount": "<string>",
"issue_date": "<string>",
"last_updated_by": {
"name": "<string>",
"object": "<string>"
},
"last_updated_on": "<string>",
"object": "<string>",
"purchase_credit_note_rows": [
{
"credit_note_from_blank_method": "<string>",
"credit_note_from_credit_note": "<string>",
"credit_note_from_payment_method": "<string>",
"credit_note_total": "<string>",
"payment_method": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"payment_processor": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"refund_from_blank_method": "<string>",
"refund_from_credit_note": "<string>",
"refund_from_payment_method": "<string>",
"refund_total": "<string>"
}
],
"purchase_payment": {
"code": "<string>",
"href": "<string>",
"id": "<string>",
"object": "<string>"
},
"refund_amount": "<string>",
"refundable": true,
"remaining_amount": "<string>",
"status": "<unknown>",
"version": 123
}
}Returns the purchase credit note with its supplier, the payment that raised it, its rows and the initial, remaining and refunded amounts, under
purchase_credit_note.
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
An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.
Path Parameters
The purchase credit note's id, such as pcn_.... Its code also works here.
Response
200 - application/json
The purchase credit note, under purchase_credit_note.
Show child attributes
Show child attributes