Add a note to a purchase credit note

cURL

curl -X POST "$EXSITED_BASE_URL/api/v4/purchase_credit_notes/pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b/notes" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --form-string 'note=<p>Credit agreed with supplier.</p>' \
  -F "file=@delivery-note.pdf"

from exsited import build_client

client = build_client()

response = client.purchase_credit_notes.create_purchase_credit_note_note(
    "pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b",
    "<p>Credit agreed with 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.purchaseCreditNotes.createPurchaseCreditNoteNote(
    'pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b',
    '<p>Credit agreed with supplier.</p>',
    {files: {file: ['delivery-note.pdf', readFileSync('delivery-note.pdf')]}},
);
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->purchaseCreditNotes->createPurchaseCreditNoteNote(
    'pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b',
    '<p>Credit agreed with supplier.</p>',
    ['file' => ['delivery-note.pdf', fopen('delivery-note.pdf', 'r')]],
);
print_r($response->data);

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.client.RequestOptions;
import java.nio.file.Path;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.purchaseCreditNotes().createPurchaseCreditNoteNote(
        "pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b",
        "<p>Credit agreed with 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.PurchaseCreditNotes.CreatePurchaseCreditNoteNoteAsync(
    "pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b",
    "<p>Credit agreed with 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.purchaseCreditNotes
    .createPurchaseCreditNoteNote(
      'pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b',
      '<p>Credit agreed with 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.PurchaseCreditNotes().CreatePurchaseCreditNoteNote(context.Background(), "pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b", "<p>Credit agreed with supplier.</p>", map[string]any{"file": []any{"delivery-note.pdf", file}}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

POST

purchase_credit_notes

{purchase_credit_note_id}

notes

cURL

curl -X POST "$EXSITED_BASE_URL/api/v4/purchase_credit_notes/pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b/notes" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --form-string 'note=<p>Credit agreed with supplier.</p>' \
  -F "file=@delivery-note.pdf"

from exsited import build_client

client = build_client()

response = client.purchase_credit_notes.create_purchase_credit_note_note(
    "pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b",
    "<p>Credit agreed with 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.purchaseCreditNotes.createPurchaseCreditNoteNote(
    'pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b',
    '<p>Credit agreed with supplier.</p>',
    {files: {file: ['delivery-note.pdf', readFileSync('delivery-note.pdf')]}},
);
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->purchaseCreditNotes->createPurchaseCreditNoteNote(
    'pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b',
    '<p>Credit agreed with supplier.</p>',
    ['file' => ['delivery-note.pdf', fopen('delivery-note.pdf', 'r')]],
);
print_r($response->data);

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.client.RequestOptions;
import java.nio.file.Path;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.purchaseCreditNotes().createPurchaseCreditNoteNote(
        "pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b",
        "<p>Credit agreed with 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.PurchaseCreditNotes.CreatePurchaseCreditNoteNoteAsync(
    "pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b",
    "<p>Credit agreed with 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.purchaseCreditNotes
    .createPurchaseCreditNoteNote(
      'pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b',
      '<p>Credit agreed with 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.PurchaseCreditNotes().CreatePurchaseCreditNoteNote(context.Background(), "pcn_5e4d3c2b1a0f4e9d8c7b6a5f4e3d2c1b", "<p>Credit agreed with supplier.</p>", map[string]any{"file": []any{"delivery-note.pdf", file}}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

Adds a note to the purchase credit note. Send a multipart form with the text as the note field and, optionally, a file to attach. Address the credit note by its pcn_ id. It needs the permission to create purchase credit note notes.

This call needs the permission to create purchase credit note notes. Without it the call returns 403.

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_credit_note_id

string

required

The purchase credit note's pcn_ id. A code returns 400.

Body

multipart/form-data

note

string

required

The note text. HTML is accepted.

file

An optional file to attach to the note.

Response

The note is created.

Guides

API reference

Add a note to a purchase credit note

Authorizations

Path Parameters

Body

Response