Retrieve a purchase payment note file

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/purchase_payments/PP-0001/notes/note_8d1e2f3a4b5c4d6e8f9a0b1c2d3e4f5a/files/6b2c1d0e-4f3a-4b5c-8d9e-0f1a2b3c4d5e" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

from exsited import build_client

client = build_client()

response = client.purchase_payments.get_purchase_payment_note_file(
    "PP-0001",
    "note_8d1e2f3a4b5c4d6e8f9a0b1c2d3e4f5a",
    "6b2c1d0e-4f3a-4b5c-8d9e-0f1a2b3c4d5e",
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.purchasePayments.getPurchasePaymentNoteFile(
    'PP-0001',
    'note_8d1e2f3a4b5c4d6e8f9a0b1c2d3e4f5a',
    '6b2c1d0e-4f3a-4b5c-8d9e-0f1a2b3c4d5e',
);
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->purchasePayments->getPurchasePaymentNoteFile(
    'PP-0001',
    'note_8d1e2f3a4b5c4d6e8f9a0b1c2d3e4f5a',
    '6b2c1d0e-4f3a-4b5c-8d9e-0f1a2b3c4d5e',
);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.purchase_payments.purchase_payments_dto.PurchasePaymentsDto.PurchasePaymentNoteFile;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<PurchasePaymentNoteFile> response = client.purchasePayments().getPurchasePaymentNoteFile(
        "PP-0001",
        "note_8d1e2f3a4b5c4d6e8f9a0b1c2d3e4f5a",
        "6b2c1d0e-4f3a-4b5c-8d9e-0f1a2b3c4d5e");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.PurchasePayments.GetPurchasePaymentNoteFileAsync(
    "PP-0001",
    "note_8d1e2f3a4b5c4d6e8f9a0b1c2d3e4f5a",
    "6b2c1d0e-4f3a-4b5c-8d9e-0f1a2b3c4d5e");

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.purchasePayments.getPurchasePaymentNoteFile(
  'PP-0001',
  'note_8d1e2f3a4b5c4d6e8f9a0b1c2d3e4f5a',
  '6b2c1d0e-4f3a-4b5c-8d9e-0f1a2b3c4d5e',
);
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().GetPurchasePaymentNoteFile(context.Background(), "PP-0001", "note_8d1e2f3a4b5c4d6e8f9a0b1c2d3e4f5a", "6b2c1d0e-4f3a-4b5c-8d9e-0f1a2b3c4d5e", nil, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "file": {
    "uuid": "<string>",
    "filename": "<string>",
    "content_type": "<string>",
    "size": 123,
    "href": "<string>"
  }
}

GET

purchase_payments

{purchase_payment_id}

notes

{pp_note_id}

files

{file_id}

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/purchase_payments/PP-0001/notes/note_8d1e2f3a4b5c4d6e8f9a0b1c2d3e4f5a/files/6b2c1d0e-4f3a-4b5c-8d9e-0f1a2b3c4d5e" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

from exsited import build_client

client = build_client()

response = client.purchase_payments.get_purchase_payment_note_file(
    "PP-0001",
    "note_8d1e2f3a4b5c4d6e8f9a0b1c2d3e4f5a",
    "6b2c1d0e-4f3a-4b5c-8d9e-0f1a2b3c4d5e",
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.purchasePayments.getPurchasePaymentNoteFile(
    'PP-0001',
    'note_8d1e2f3a4b5c4d6e8f9a0b1c2d3e4f5a',
    '6b2c1d0e-4f3a-4b5c-8d9e-0f1a2b3c4d5e',
);
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->purchasePayments->getPurchasePaymentNoteFile(
    'PP-0001',
    'note_8d1e2f3a4b5c4d6e8f9a0b1c2d3e4f5a',
    '6b2c1d0e-4f3a-4b5c-8d9e-0f1a2b3c4d5e',
);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.purchase_payments.purchase_payments_dto.PurchasePaymentsDto.PurchasePaymentNoteFile;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<PurchasePaymentNoteFile> response = client.purchasePayments().getPurchasePaymentNoteFile(
        "PP-0001",
        "note_8d1e2f3a4b5c4d6e8f9a0b1c2d3e4f5a",
        "6b2c1d0e-4f3a-4b5c-8d9e-0f1a2b3c4d5e");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.PurchasePayments.GetPurchasePaymentNoteFileAsync(
    "PP-0001",
    "note_8d1e2f3a4b5c4d6e8f9a0b1c2d3e4f5a",
    "6b2c1d0e-4f3a-4b5c-8d9e-0f1a2b3c4d5e");

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.purchasePayments.getPurchasePaymentNoteFile(
  'PP-0001',
  'note_8d1e2f3a4b5c4d6e8f9a0b1c2d3e4f5a',
  '6b2c1d0e-4f3a-4b5c-8d9e-0f1a2b3c4d5e',
);
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().GetPurchasePaymentNoteFile(context.Background(), "PP-0001", "note_8d1e2f3a4b5c4d6e8f9a0b1c2d3e4f5a", "6b2c1d0e-4f3a-4b5c-8d9e-0f1a2b3c4d5e", nil, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "file": {
    "uuid": "<string>",
    "filename": "<string>",
    "content_type": "<string>",
    "size": 123,
    "href": "<string>"
  }
}

Returns one attachment’s name, content type, size, uuid and link under file. Address the file by its uuid.

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_payment_id

string

required

The purchase payment's id.

pp_note_id

string

required

The note's id, from the note create or the notes list.

file_id

string

required

The attachment's uuid, from the note's attachments.

Response

200 - application/json

The file's details, under file.

file

object

Show child attributes

Guides

API reference

Retrieve a purchase payment note file

Authorizations

Path Parameters

Response