cURL
curl -X PATCH "$EXSITED_BASE_URL/api/v4/purchase_invoices/PI-0001/information" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"purchase_invoice": {
"origin": "Supplier portal"
}
}'from exsited import build_client
client = build_client()
response = client.purchase_invoices.update_purchase_invoice_information(
"PI-0001", {"purchase_invoice": {"origin": "Supplier portal"}}
)
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.purchaseInvoices.updatePurchaseInvoiceInformation('PI-0001', {
purchase_invoice: {origin: 'Supplier portal'},
});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->purchaseInvoices->updatePurchaseInvoiceInformation('PI-0001', [
'purchase_invoice' => ['origin' => 'Supplier portal'],
]);
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.PurchaseInvoiceInformation;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<PurchaseInvoiceInformation> response = client.purchaseInvoices().updatePurchaseInvoiceInformation(
"PI-0001",
Map.of("purchase_invoice", Map.of("origin", "Supplier portal")));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.PurchaseInvoices.UpdatePurchaseInvoiceInformationAsync(
"PI-0001",
new Dictionary<string, object?>
{
["purchase_invoice"] = new Dictionary<string, object?>
{
["origin"] = "Supplier portal",
},
});
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.purchaseInvoices
.updatePurchaseInvoiceInformation('PI-0001', {
'purchase_invoice': {'origin': 'Supplier portal'},
});
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().UpdatePurchaseInvoiceInformation(context.Background(), "PI-0001", map[string]any{
"purchase_invoice": map[string]any{"origin": "Supplier portal"},
}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"purchase_invoice": {
"account": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"activity_logs": [
"<unknown>"
],
"alternate_due_date": "<string>",
"alternate_issue_date": "<string>",
"created_by": {
"name": "<string>",
"object": "<string>"
},
"created_on": "<string>",
"currency": {
"code": "<string>",
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>"
},
"custom_attributes": [
"<unknown>"
],
"custom_form": "<unknown>",
"due_date": "<string>",
"id": "<string>",
"invoice_note": "<string>",
"issue_date": "<string>",
"kpis": {
"credit_applied": "<string>",
"credit_issued": "<string>",
"deleted_on": "<unknown>",
"last_amended_on": "<unknown>",
"last_cancelled_on": "<unknown>",
"last_payment_date": "<unknown>",
"last_reactivated_on": "<unknown>",
"object": "<string>",
"outstanding": "<string>",
"overdue": "<string>",
"payment_applied": "<string>",
"voided_on": "<unknown>"
},
"last_updated_by": {
"name": "<string>",
"object": "<string>"
},
"last_updated_on": "<string>",
"lines": [
{
"accounting_code": "<string>",
"id": "<string>",
"item": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"object": "<string>",
"quantity": 123,
"subtotal": "<string>",
"tax": "<string>",
"total": "<string>",
"uom": "<string>",
"version": 123,
"warehouse": "<string>"
}
],
"object": "<string>",
"origin": "<string>",
"payment_status": "<string>",
"price_tax_inclusive": true,
"purchase_order": "<unknown>",
"status": "<string>",
"subtotal": "<string>",
"tax": "<string>",
"total": "<string>",
"uuid": "<string>",
"version": 123
}
}Purchase invoices
Update a purchase invoice's information
Changes header fields of a purchase invoice and returns it under purchase_invoice.
PATCH
/
purchase_invoices
/
{purchase_invoice_id}
/
information
cURL
curl -X PATCH "$EXSITED_BASE_URL/api/v4/purchase_invoices/PI-0001/information" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"purchase_invoice": {
"origin": "Supplier portal"
}
}'from exsited import build_client
client = build_client()
response = client.purchase_invoices.update_purchase_invoice_information(
"PI-0001", {"purchase_invoice": {"origin": "Supplier portal"}}
)
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.purchaseInvoices.updatePurchaseInvoiceInformation('PI-0001', {
purchase_invoice: {origin: 'Supplier portal'},
});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->purchaseInvoices->updatePurchaseInvoiceInformation('PI-0001', [
'purchase_invoice' => ['origin' => 'Supplier portal'],
]);
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.PurchaseInvoiceInformation;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<PurchaseInvoiceInformation> response = client.purchaseInvoices().updatePurchaseInvoiceInformation(
"PI-0001",
Map.of("purchase_invoice", Map.of("origin", "Supplier portal")));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.PurchaseInvoices.UpdatePurchaseInvoiceInformationAsync(
"PI-0001",
new Dictionary<string, object?>
{
["purchase_invoice"] = new Dictionary<string, object?>
{
["origin"] = "Supplier portal",
},
});
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.purchaseInvoices
.updatePurchaseInvoiceInformation('PI-0001', {
'purchase_invoice': {'origin': 'Supplier portal'},
});
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().UpdatePurchaseInvoiceInformation(context.Background(), "PI-0001", map[string]any{
"purchase_invoice": map[string]any{"origin": "Supplier portal"},
}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"purchase_invoice": {
"account": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"activity_logs": [
"<unknown>"
],
"alternate_due_date": "<string>",
"alternate_issue_date": "<string>",
"created_by": {
"name": "<string>",
"object": "<string>"
},
"created_on": "<string>",
"currency": {
"code": "<string>",
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>"
},
"custom_attributes": [
"<unknown>"
],
"custom_form": "<unknown>",
"due_date": "<string>",
"id": "<string>",
"invoice_note": "<string>",
"issue_date": "<string>",
"kpis": {
"credit_applied": "<string>",
"credit_issued": "<string>",
"deleted_on": "<unknown>",
"last_amended_on": "<unknown>",
"last_cancelled_on": "<unknown>",
"last_payment_date": "<unknown>",
"last_reactivated_on": "<unknown>",
"object": "<string>",
"outstanding": "<string>",
"overdue": "<string>",
"payment_applied": "<string>",
"voided_on": "<unknown>"
},
"last_updated_by": {
"name": "<string>",
"object": "<string>"
},
"last_updated_on": "<string>",
"lines": [
{
"accounting_code": "<string>",
"id": "<string>",
"item": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"object": "<string>",
"quantity": 123,
"subtotal": "<string>",
"tax": "<string>",
"total": "<string>",
"uom": "<string>",
"version": 123,
"warehouse": "<string>"
}
],
"object": "<string>",
"origin": "<string>",
"payment_status": "<string>",
"price_tax_inclusive": true,
"purchase_order": "<unknown>",
"status": "<string>",
"subtotal": "<string>",
"tax": "<string>",
"total": "<string>",
"uuid": "<string>",
"version": 123
}
}Updates header fields of the purchase invoice, such as
origin, wrapped in purchase_invoice. The updated invoice comes back under purchase_invoice.
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. To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its -d payload.Authorizations
An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.
Path Parameters
The purchase invoice's id.
Body
application/json
Show child attributes
Show child attributes
Response
200 - application/json
The updated purchase invoice, under purchase_invoice.
Show child attributes
Show child attributes