cURL
curl -X POST "$EXSITED_BASE_URL/api/v4/purchase_payments" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"purchase_payment": {
"payment_method_applications": [
{
"amount": "1.00",
"payment_processor": "PROC-0001"
}
],
"purchase_invoice_applications": [
{
"purchase_invoice": "PI-0001",
"amount": "1.00"
}
]
}
}'from exsited import build_client
client = build_client()
response = client.purchase_payments.create_purchase_payment(
{
"purchase_payment": {
"payment_method_applications": [
{"amount": "1.00", "payment_processor": "PROC-0001"}
],
"purchase_invoice_applications": [
{"purchase_invoice": "PI-0001", "amount": "1.00"}
],
}
}
)
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.purchasePayments.createPurchasePayment({
purchase_payment: {
payment_method_applications: [{amount: '1.00', payment_processor: 'PROC-0001'}],
purchase_invoice_applications: [{purchase_invoice: 'PI-0001', amount: '1.00'}],
},
});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->purchasePayments->createPurchasePayment([
'purchase_payment' => [
'payment_method_applications' => [['amount' => '1.00', 'payment_processor' => 'PROC-0001']],
'purchase_invoice_applications' => [['purchase_invoice' => 'PI-0001', 'amount' => '1.00']],
],
]);
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;
import java.util.List;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<PurchasePaymentsDto.PurchasePayments> response = client.purchasePayments().createPurchasePayment(
Map.of(
"purchase_payment", Map.of(
"payment_method_applications", List.of(
Map.of("amount", "1.00", "payment_processor", "PROC-0001")),
"purchase_invoice_applications", List.of(
Map.of("purchase_invoice", "PI-0001", "amount", "1.00")))));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.PurchasePayments.CreatePurchasePaymentAsync(new Dictionary<string, object?>
{
["purchase_payment"] = new Dictionary<string, object?>
{
["payment_method_applications"] = new List<object?>
{
new Dictionary<string, object?>
{
["amount"] = "1.00",
["payment_processor"] = "PROC-0001",
},
},
["purchase_invoice_applications"] = new List<object?>
{
new Dictionary<string, object?>
{
["purchase_invoice"] = "PI-0001",
["amount"] = "1.00",
},
},
},
});
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.purchasePayments.createPurchasePayment({
'purchase_payment': {
'payment_method_applications': [
{'amount': '1.00', 'payment_processor': 'PROC-0001'},
],
'purchase_invoice_applications': [
{'purchase_invoice': 'PI-0001', 'amount': '1.00'},
],
},
});
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().CreatePurchasePayment(context.Background(), map[string]any{
"purchase_payment": map[string]any{
"payment_method_applications": []any{
map[string]any{
"amount": "1.00",
"payment_processor": "PROC-0001",
},
},
"purchase_invoice_applications": []any{
map[string]any{
"purchase_invoice": "PI-0001",
"amount": "1.00",
},
},
},
}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"purchase_payment": {
"account": {
"code": "<string>",
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>"
},
"activity_logs": [
{
"activity": "<string>"
}
],
"code": "<string>",
"created_by": {
"name": "<string>",
"object": "<string>"
},
"created_on": "<string>",
"credit_note_applications": [
{
"amount": "<string>",
"purchase_credit_note": {
"code": "<string>",
"href": "<string>",
"id": "<string>",
"object": "<string>"
}
}
],
"credit_note_total": "<string>",
"currency": {
"code": "<string>",
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>"
},
"custom_attributes": [
"<unknown>"
],
"custom_objects": [
"<unknown>"
],
"href": "<string>",
"id": "<string>",
"last_updated_by": "<string>",
"last_updated_on": "<string>",
"object": "<string>",
"origin": "<string>",
"paid_total": "<string>",
"payment_date": "<string>",
"payment_method_applications": [
{
"amount": "<string>",
"payment_method": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"payment_processor": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"reference": "<string>"
}
],
"payment_note": "<string>",
"payment_reference": "<unknown>",
"purchase_credit_applied": [
"<unknown>"
],
"purchase_invoice_applications": [
{
"applied": "<string>",
"due_date": "<string>",
"issue_date": "<string>",
"outstanding": "<string>",
"purchase_invoice": {
"code": "<string>",
"href": "<string>",
"id": "<string>",
"object": "<string>"
},
"total": "<string>"
}
],
"purchase_invoices": [
"<unknown>"
],
"purchase_order_id": "<string>",
"purchase_payment_applied": [
"<unknown>"
],
"purchase_payment_date": "<string>",
"purchase_payment_note": "<string>",
"status": "<string>",
"total_applied": "<string>",
"uuid": "<string>",
"version": 123
}
}Purchase payments
Create a purchase payment
Records a payment to a supplier and returns it under purchase_payment.
POST
/
purchase_payments
cURL
curl -X POST "$EXSITED_BASE_URL/api/v4/purchase_payments" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"purchase_payment": {
"payment_method_applications": [
{
"amount": "1.00",
"payment_processor": "PROC-0001"
}
],
"purchase_invoice_applications": [
{
"purchase_invoice": "PI-0001",
"amount": "1.00"
}
]
}
}'from exsited import build_client
client = build_client()
response = client.purchase_payments.create_purchase_payment(
{
"purchase_payment": {
"payment_method_applications": [
{"amount": "1.00", "payment_processor": "PROC-0001"}
],
"purchase_invoice_applications": [
{"purchase_invoice": "PI-0001", "amount": "1.00"}
],
}
}
)
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.purchasePayments.createPurchasePayment({
purchase_payment: {
payment_method_applications: [{amount: '1.00', payment_processor: 'PROC-0001'}],
purchase_invoice_applications: [{purchase_invoice: 'PI-0001', amount: '1.00'}],
},
});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->purchasePayments->createPurchasePayment([
'purchase_payment' => [
'payment_method_applications' => [['amount' => '1.00', 'payment_processor' => 'PROC-0001']],
'purchase_invoice_applications' => [['purchase_invoice' => 'PI-0001', 'amount' => '1.00']],
],
]);
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;
import java.util.List;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<PurchasePaymentsDto.PurchasePayments> response = client.purchasePayments().createPurchasePayment(
Map.of(
"purchase_payment", Map.of(
"payment_method_applications", List.of(
Map.of("amount", "1.00", "payment_processor", "PROC-0001")),
"purchase_invoice_applications", List.of(
Map.of("purchase_invoice", "PI-0001", "amount", "1.00")))));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.PurchasePayments.CreatePurchasePaymentAsync(new Dictionary<string, object?>
{
["purchase_payment"] = new Dictionary<string, object?>
{
["payment_method_applications"] = new List<object?>
{
new Dictionary<string, object?>
{
["amount"] = "1.00",
["payment_processor"] = "PROC-0001",
},
},
["purchase_invoice_applications"] = new List<object?>
{
new Dictionary<string, object?>
{
["purchase_invoice"] = "PI-0001",
["amount"] = "1.00",
},
},
},
});
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.purchasePayments.createPurchasePayment({
'purchase_payment': {
'payment_method_applications': [
{'amount': '1.00', 'payment_processor': 'PROC-0001'},
],
'purchase_invoice_applications': [
{'purchase_invoice': 'PI-0001', 'amount': '1.00'},
],
},
});
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().CreatePurchasePayment(context.Background(), map[string]any{
"purchase_payment": map[string]any{
"payment_method_applications": []any{
map[string]any{
"amount": "1.00",
"payment_processor": "PROC-0001",
},
},
"purchase_invoice_applications": []any{
map[string]any{
"purchase_invoice": "PI-0001",
"amount": "1.00",
},
},
},
}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"purchase_payment": {
"account": {
"code": "<string>",
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>"
},
"activity_logs": [
{
"activity": "<string>"
}
],
"code": "<string>",
"created_by": {
"name": "<string>",
"object": "<string>"
},
"created_on": "<string>",
"credit_note_applications": [
{
"amount": "<string>",
"purchase_credit_note": {
"code": "<string>",
"href": "<string>",
"id": "<string>",
"object": "<string>"
}
}
],
"credit_note_total": "<string>",
"currency": {
"code": "<string>",
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>"
},
"custom_attributes": [
"<unknown>"
],
"custom_objects": [
"<unknown>"
],
"href": "<string>",
"id": "<string>",
"last_updated_by": "<string>",
"last_updated_on": "<string>",
"object": "<string>",
"origin": "<string>",
"paid_total": "<string>",
"payment_date": "<string>",
"payment_method_applications": [
{
"amount": "<string>",
"payment_method": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"payment_processor": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"reference": "<string>"
}
],
"payment_note": "<string>",
"payment_reference": "<unknown>",
"purchase_credit_applied": [
"<unknown>"
],
"purchase_invoice_applications": [
{
"applied": "<string>",
"due_date": "<string>",
"issue_date": "<string>",
"outstanding": "<string>",
"purchase_invoice": {
"code": "<string>",
"href": "<string>",
"id": "<string>",
"object": "<string>"
},
"total": "<string>"
}
],
"purchase_invoices": [
"<unknown>"
],
"purchase_order_id": "<string>",
"purchase_payment_applied": [
"<unknown>"
],
"purchase_payment_date": "<string>",
"purchase_payment_note": "<string>",
"status": "<string>",
"total_applied": "<string>",
"uuid": "<string>",
"version": 123
}
}Records a purchase payment, wrapped in
purchase_payment. payment_method_applications says how it is paid, purchase_invoice_applications which invoices it pays, and credit_note_applications which purchase credit notes it spends. Paying more than the invoices take raises a purchase credit 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. 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.
Body
application/json
Show child attributes
Show child attributes
Response
201 - application/json
The new purchase payment, under purchase_payment.
Show child attributes
Show child attributes