cURL
curl -X GET "$EXSITED_BASE_URL/api/v4/purchase_payments/PP-0001/purchase_credit_notes?limit=20" \
-H "Authorization: Bearer $ACCESS_TOKEN"from exsited import build_client
client = build_client()
response = client.purchase_payments.get_purchase_payment_purchase_credit_notes(
"PP-0001", {"limit": 20}
)
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.purchasePayments.getPurchasePaymentPurchaseCreditNotes('PP-0001', {limit: 20});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->purchasePayments->getPurchasePaymentPurchaseCreditNotes('PP-0001', [
'limit' => 20,
]);
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.PurchaseCreditNoteList;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<PurchaseCreditNoteList> response = client.purchasePayments().getPurchasePaymentPurchaseCreditNotes(
"PP-0001",
Map.of("limit", 20));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.PurchasePayments.GetPurchasePaymentPurchaseCreditNotesAsync(
"PP-0001",
new Dictionary<string, object?> { ["limit"] = 20 });
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.purchasePayments
.getPurchasePaymentPurchaseCreditNotes(
'PP-0001',
queryParams: {'limit': 20},
);
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.PurchasePayments().GetPurchasePaymentPurchaseCreditNotes(context.Background(), "PP-0001", map[string]any{"limit": 20}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"data": [
{
"account": {
"code": "<string>",
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>"
},
"amount": "<string>",
"code": "<string>",
"created_by": {
"name": "<string>",
"object": "<string>"
},
"created_on": "<string>",
"currency": {
"code": "<string>",
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>"
},
"custom_attributes": [
"<unknown>"
],
"date": "<string>",
"href": "<string>",
"id": "<string>",
"initial_amount": "<string>",
"issue_date": "<string>",
"last_updated_by": {
"name": "<string>",
"object": "<string>"
},
"last_updated_on": "<string>",
"object": "<string>",
"payment_id": "<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>",
"remaining_balance": "<string>",
"status": "<string>",
"uuid": "<string>",
"version": 123
}
],
"object": "<string>",
"pagination": {
"limit": 123,
"has_more": true,
"next_cursor": "<string>",
"prev_cursor": "<string>",
"links": {
"next": "<string>",
"prev": "<string>"
}
},
"url": "<string>"
}Purchase payments
List a purchase payment's purchase credit notes
Returns one page of the purchase credit notes a purchase payment raised.
GET
/
purchase_payments
/
{purchase_payment_id}
/
purchase_credit_notes
cURL
curl -X GET "$EXSITED_BASE_URL/api/v4/purchase_payments/PP-0001/purchase_credit_notes?limit=20" \
-H "Authorization: Bearer $ACCESS_TOKEN"from exsited import build_client
client = build_client()
response = client.purchase_payments.get_purchase_payment_purchase_credit_notes(
"PP-0001", {"limit": 20}
)
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.purchasePayments.getPurchasePaymentPurchaseCreditNotes('PP-0001', {limit: 20});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->purchasePayments->getPurchasePaymentPurchaseCreditNotes('PP-0001', [
'limit' => 20,
]);
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.PurchaseCreditNoteList;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<PurchaseCreditNoteList> response = client.purchasePayments().getPurchasePaymentPurchaseCreditNotes(
"PP-0001",
Map.of("limit", 20));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.PurchasePayments.GetPurchasePaymentPurchaseCreditNotesAsync(
"PP-0001",
new Dictionary<string, object?> { ["limit"] = 20 });
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.purchasePayments
.getPurchasePaymentPurchaseCreditNotes(
'PP-0001',
queryParams: {'limit': 20},
);
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.PurchasePayments().GetPurchasePaymentPurchaseCreditNotes(context.Background(), "PP-0001", map[string]any{"limit": 20}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"data": [
{
"account": {
"code": "<string>",
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>"
},
"amount": "<string>",
"code": "<string>",
"created_by": {
"name": "<string>",
"object": "<string>"
},
"created_on": "<string>",
"currency": {
"code": "<string>",
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>"
},
"custom_attributes": [
"<unknown>"
],
"date": "<string>",
"href": "<string>",
"id": "<string>",
"initial_amount": "<string>",
"issue_date": "<string>",
"last_updated_by": {
"name": "<string>",
"object": "<string>"
},
"last_updated_on": "<string>",
"object": "<string>",
"payment_id": "<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>",
"remaining_balance": "<string>",
"status": "<string>",
"uuid": "<string>",
"version": 123
}
],
"object": "<string>",
"pagination": {
"limit": 123,
"has_more": true,
"next_cursor": "<string>",
"prev_cursor": "<string>",
"links": {
"next": "<string>",
"prev": "<string>"
}
},
"url": "<string>"
}Lists the purchase credit notes the payment raised, under
data. A payment raises one when it pays more than its invoices take; a payment that does not overpay has an empty list.
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 payment's id.
Query Parameters
The most records to return on one page.
Example:
20
The next_cursor value from the previous page, to read the next one.
The field to sort by. Prefix it with - for descending order, such as -created_on.
Example:
"-created_on"