List a purchase invoice's credit note applications

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/purchase_invoices/PI-0001/purchase_credit_note_applications?limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

from exsited import build_client

client = build_client()

response = (
    client.purchase_invoices.get_purchase_invoice_purchase_credit_note_applications(
        "PI-0001", {"limit": 20}
    )
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.purchaseInvoices.getPurchaseInvoicePurchaseCreditNoteApplications('PI-0001', {limit: 20});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->purchaseInvoices->getPurchaseInvoicePurchaseCreditNoteApplications('PI-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_invoices.purchase_invoices_dto.PurchaseInvoicesDto.AccountPurchaseInvoices;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<AccountPurchaseInvoices> response = client.purchaseInvoices().getPurchaseInvoicePurchaseCreditNoteApplications(
        "PI-0001",
        Map.of("limit", 20));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.PurchaseInvoices.GetPurchaseInvoicePurchaseCreditNoteApplicationsAsync(
    "PI-0001",
    new Dictionary<string, object?> { ["limit"] = 20 });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.purchaseInvoices
    .getPurchaseInvoicePurchaseCreditNoteApplications(
      'PI-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.PurchaseInvoices().GetPurchaseInvoicePurchaseCreditNoteApplications(context.Background(), "PI-0001", map[string]any{"limit": 20}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "data": [
    {
      "amount": "<string>",
      "created_by": {
        "name": "<string>",
        "object": "<string>"
      },
      "created_on": "<string>",
      "href": "<string>",
      "id": "<string>",
      "issue_date": "<string>",
      "last_updated_by": "<unknown>",
      "last_updated_on": "<string>",
      "object": "<string>",
      "purchase_credit_note": {
        "object": "<string>",
        "id": "<string>",
        "name": "<string>",
        "href": "<string>"
      },
      "purchase_payment": {
        "object": "<string>",
        "id": "<string>",
        "name": "<string>",
        "href": "<string>"
      },
      "remaining_balance": "<string>",
      "status": "<string>",
      "version": 123
    }
  ],
  "object": "<string>",
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  },
  "url": "<string>"
}

GET

purchase_invoices

{purchase_invoice_id}

purchase_credit_note_applications

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/purchase_invoices/PI-0001/purchase_credit_note_applications?limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

from exsited import build_client

client = build_client()

response = (
    client.purchase_invoices.get_purchase_invoice_purchase_credit_note_applications(
        "PI-0001", {"limit": 20}
    )
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.purchaseInvoices.getPurchaseInvoicePurchaseCreditNoteApplications('PI-0001', {limit: 20});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->purchaseInvoices->getPurchaseInvoicePurchaseCreditNoteApplications('PI-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_invoices.purchase_invoices_dto.PurchaseInvoicesDto.AccountPurchaseInvoices;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<AccountPurchaseInvoices> response = client.purchaseInvoices().getPurchaseInvoicePurchaseCreditNoteApplications(
        "PI-0001",
        Map.of("limit", 20));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.PurchaseInvoices.GetPurchaseInvoicePurchaseCreditNoteApplicationsAsync(
    "PI-0001",
    new Dictionary<string, object?> { ["limit"] = 20 });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.purchaseInvoices
    .getPurchaseInvoicePurchaseCreditNoteApplications(
      'PI-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.PurchaseInvoices().GetPurchaseInvoicePurchaseCreditNoteApplications(context.Background(), "PI-0001", map[string]any{"limit": 20}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "data": [
    {
      "amount": "<string>",
      "created_by": {
        "name": "<string>",
        "object": "<string>"
      },
      "created_on": "<string>",
      "href": "<string>",
      "id": "<string>",
      "issue_date": "<string>",
      "last_updated_by": "<unknown>",
      "last_updated_on": "<string>",
      "object": "<string>",
      "purchase_credit_note": {
        "object": "<string>",
        "id": "<string>",
        "name": "<string>",
        "href": "<string>"
      },
      "purchase_payment": {
        "object": "<string>",
        "id": "<string>",
        "name": "<string>",
        "href": "<string>"
      },
      "remaining_balance": "<string>",
      "status": "<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 note applications on the purchase invoice under data: each one shows the credit note spent, the payment that spent it and the amount.

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

purchase_invoice_id

string

required

The purchase invoice's id.

Query Parameters

limit

integer

The most records to return on one page.

Example:

20

cursor

string

The next_cursor value from the previous page, to read the next one.

sort

string

The field to sort by. Prefix it with - for descending order, such as -created_on.

Example:

"-created_on"

Response

200 - application/json

One page of the invoice's credit note applications.

data

object[]

Show child attributes

object

string

pagination

object

Show child attributes

url

string

Guides

API reference

List a purchase invoice's credit note applications

Authorizations

Path Parameters

Query Parameters

Response