Update a purchase payment note

cURL

curl -X PATCH "$EXSITED_BASE_URL/api/v4/purchase_payments/PP-0001/notes/note_8d1e2f3a4b5c4d6e8f9a0b1c2d3e4f5a" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --form-string 'note=<p>Remittance advice sent to supplier.</p>' \
  -F "file=@delivery-note.pdf"

from exsited import build_client

client = build_client()

response = client.purchase_payments.update_purchase_payment_note(
    "PP-0001",
    "note_8d1e2f3a4b5c4d6e8f9a0b1c2d3e4f5a",
    "<p>Remittance advice sent to supplier.</p>",
    files={"file": open("delivery-note.pdf", "rb")},
)
print(response.data)

import {readFileSync} from 'node:fs';
import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.purchasePayments.updatePurchasePaymentNote(
    'PP-0001',
    'note_8d1e2f3a4b5c4d6e8f9a0b1c2d3e4f5a',
    '<p>Remittance advice sent to supplier.</p>',
    {files: {file: ['delivery-note.pdf', readFileSync('delivery-note.pdf')]}},
);
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->purchasePayments->updatePurchasePaymentNote(
    'PP-0001',
    'note_8d1e2f3a4b5c4d6e8f9a0b1c2d3e4f5a',
    '<p>Remittance advice sent to supplier.</p>',
    ['file' => ['delivery-note.pdf', fopen('delivery-note.pdf', 'r')]],
);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.client.RequestOptions;
import com.exsited.resources.purchase_payments.purchase_payments_dto.PurchasePaymentsDto.PurchasePaymentNoteUpdated;
import java.nio.file.Path;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<PurchasePaymentNoteUpdated> response = client.purchasePayments().updatePurchasePaymentNote(
        "PP-0001",
        "note_8d1e2f3a4b5c4d6e8f9a0b1c2d3e4f5a",
        "<p>Remittance advice sent to supplier.</p>",
        Map.of("file", Path.of("delivery-note.pdf")),
        RequestOptions.none());
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.PurchasePayments.UpdatePurchasePaymentNoteAsync(
    "PP-0001",
    "note_8d1e2f3a4b5c4d6e8f9a0b1c2d3e4f5a",
    "<p>Remittance advice sent to supplier.</p>",
    new Dictionary<string, object?> { ["file"] = new object?[] { "delivery-note.pdf", File.ReadAllBytes("delivery-note.pdf") } });

Console.WriteLine(response.Json);

import 'dart:io';

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.purchasePayments.updatePurchasePaymentNote(
  'PP-0001',
  'note_8d1e2f3a4b5c4d6e8f9a0b1c2d3e4f5a',
  '<p>Remittance advice sent to supplier.</p>',
  files: {
    'file': [
      'delivery-note.pdf',
      File('delivery-note.pdf').readAsBytesSync(),
    ],
  },
);
print(response.map);

import (
	"context"
	"fmt"
	"log"
	"os"

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

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

file, err := os.ReadFile("delivery-note.pdf")
if err != nil {
	log.Fatal(err)
}
response, err := client.PurchasePayments().UpdatePurchasePaymentNote(context.Background(), "PP-0001", "note_8d1e2f3a4b5c4d6e8f9a0b1c2d3e4f5a", "<p>Remittance advice sent to supplier.</p>", map[string]any{"file": []any{"delivery-note.pdf", file}}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "note": {
    "attachments": [
      {
        "uuid": "<string>",
        "filename": "<string>",
        "content_type": "<string>",
        "size": 123,
        "href": "<string>"
      }
    ],
    "content": "<string>",
    "created_by": {
      "name": "<string>",
      "object": "<string>"
    },
    "created_on": "<string>",
    "group": "<unknown>",
    "href": "<string>",
    "id": "<string>",
    "last_updated_by": {
      "name": "<string>",
      "object": "<string>"
    },
    "last_updated_on": "<string>",
    "object": "<string>",
    "purchase_payment": {
      "href": "<string>",
      "id": "<string>",
      "object": "<string>"
    },
    "user": "<unknown>",
    "version": 123,
    "watchers": [
      "<unknown>"
    ]
  }
}

PATCH

purchase_payments

{purchase_payment_id}

notes

{pp_note_id}

cURL

curl -X PATCH "$EXSITED_BASE_URL/api/v4/purchase_payments/PP-0001/notes/note_8d1e2f3a4b5c4d6e8f9a0b1c2d3e4f5a" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --form-string 'note=<p>Remittance advice sent to supplier.</p>' \
  -F "file=@delivery-note.pdf"

from exsited import build_client

client = build_client()

response = client.purchase_payments.update_purchase_payment_note(
    "PP-0001",
    "note_8d1e2f3a4b5c4d6e8f9a0b1c2d3e4f5a",
    "<p>Remittance advice sent to supplier.</p>",
    files={"file": open("delivery-note.pdf", "rb")},
)
print(response.data)

import {readFileSync} from 'node:fs';
import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.purchasePayments.updatePurchasePaymentNote(
    'PP-0001',
    'note_8d1e2f3a4b5c4d6e8f9a0b1c2d3e4f5a',
    '<p>Remittance advice sent to supplier.</p>',
    {files: {file: ['delivery-note.pdf', readFileSync('delivery-note.pdf')]}},
);
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->purchasePayments->updatePurchasePaymentNote(
    'PP-0001',
    'note_8d1e2f3a4b5c4d6e8f9a0b1c2d3e4f5a',
    '<p>Remittance advice sent to supplier.</p>',
    ['file' => ['delivery-note.pdf', fopen('delivery-note.pdf', 'r')]],
);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.client.RequestOptions;
import com.exsited.resources.purchase_payments.purchase_payments_dto.PurchasePaymentsDto.PurchasePaymentNoteUpdated;
import java.nio.file.Path;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<PurchasePaymentNoteUpdated> response = client.purchasePayments().updatePurchasePaymentNote(
        "PP-0001",
        "note_8d1e2f3a4b5c4d6e8f9a0b1c2d3e4f5a",
        "<p>Remittance advice sent to supplier.</p>",
        Map.of("file", Path.of("delivery-note.pdf")),
        RequestOptions.none());
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.PurchasePayments.UpdatePurchasePaymentNoteAsync(
    "PP-0001",
    "note_8d1e2f3a4b5c4d6e8f9a0b1c2d3e4f5a",
    "<p>Remittance advice sent to supplier.</p>",
    new Dictionary<string, object?> { ["file"] = new object?[] { "delivery-note.pdf", File.ReadAllBytes("delivery-note.pdf") } });

Console.WriteLine(response.Json);

import 'dart:io';

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.purchasePayments.updatePurchasePaymentNote(
  'PP-0001',
  'note_8d1e2f3a4b5c4d6e8f9a0b1c2d3e4f5a',
  '<p>Remittance advice sent to supplier.</p>',
  files: {
    'file': [
      'delivery-note.pdf',
      File('delivery-note.pdf').readAsBytesSync(),
    ],
  },
);
print(response.map);

import (
	"context"
	"fmt"
	"log"
	"os"

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

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

file, err := os.ReadFile("delivery-note.pdf")
if err != nil {
	log.Fatal(err)
}
response, err := client.PurchasePayments().UpdatePurchasePaymentNote(context.Background(), "PP-0001", "note_8d1e2f3a4b5c4d6e8f9a0b1c2d3e4f5a", "<p>Remittance advice sent to supplier.</p>", map[string]any{"file": []any{"delivery-note.pdf", file}}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "note": {
    "attachments": [
      {
        "uuid": "<string>",
        "filename": "<string>",
        "content_type": "<string>",
        "size": 123,
        "href": "<string>"
      }
    ],
    "content": "<string>",
    "created_by": {
      "name": "<string>",
      "object": "<string>"
    },
    "created_on": "<string>",
    "group": "<unknown>",
    "href": "<string>",
    "id": "<string>",
    "last_updated_by": {
      "name": "<string>",
      "object": "<string>"
    },
    "last_updated_on": "<string>",
    "object": "<string>",
    "purchase_payment": {
      "href": "<string>",
      "id": "<string>",
      "object": "<string>"
    },
    "user": "<unknown>",
    "version": 123,
    "watchers": [
      "<unknown>"
    ]
  }
}

Changes the note’s text. Send a multipart form with the new text as the note field and, optionally, a file to attach. The updated note comes back under 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

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.

Body

multipart/form-data

note

string

required

The new note text. HTML is accepted.

file

An optional file to attach to the note.

Response

200 - application/json

The updated note, under note.

note

object

Show child attributes

Guides

API reference

Update a purchase payment note

Authorizations

Path Parameters

Body

Response