Pay a pro-forma invoice

cURL

curl -X POST "$EXSITED_BASE_URL/api/v4/proforma_invoices/PF-0001/payments" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "payment": {}
  }'

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.proformaInvoices.createProformaInvoicePayment('PF-0001', {payment: {}});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->proformaInvoices->createProformaInvoicePayment('PF-0001', [
    'payment' => (object) [],
]);
print_r($response->data);

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.proformaInvoices().createProformaInvoicePayment(
        "PF-0001",
        Map.of("payment", Map.of()));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.ProformaInvoices.CreateProformaInvoicePaymentAsync(
    "PF-0001",
    new Dictionary<string, object?>
    {
        ["payment"] = new Dictionary<string, object?>(),
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.proformaInvoices.createProformaInvoicePayment(
  'PF-0001',
  {'payment': {}},
);
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.ProformaInvoices().CreateProformaInvoicePayment(context.Background(), "PF-0001", map[string]any{"payment": map[string]any{}}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

POST

proforma_invoices

{proforma_id}

payments

cURL

curl -X POST "$EXSITED_BASE_URL/api/v4/proforma_invoices/PF-0001/payments" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "payment": {}
  }'

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.proformaInvoices.createProformaInvoicePayment('PF-0001', {payment: {}});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->proformaInvoices->createProformaInvoicePayment('PF-0001', [
    'payment' => (object) [],
]);
print_r($response->data);

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.proformaInvoices().createProformaInvoicePayment(
        "PF-0001",
        Map.of("payment", Map.of()));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.ProformaInvoices.CreateProformaInvoicePaymentAsync(
    "PF-0001",
    new Dictionary<string, object?>
    {
        ["payment"] = new Dictionary<string, object?>(),
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.proformaInvoices.createProformaInvoicePayment(
  'PF-0001',
  {'payment': {}},
);
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.ProformaInvoices().CreateProformaInvoicePayment(context.Background(), "PF-0001", map[string]any{"payment": map[string]any{}}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

Takes a payment for the pro-forma invoice from the fields under payment. The fields this body takes are not documented yet; the sample shows only the required payment wrapper. The response is not the payment itself: it carries object, payment_id with the new payment’s code, and a message, under payment.

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

Authorization

string

header

required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

proforma_id

string

required

The pro-forma invoice's code, which it returns as both id and invoice_id.

Body

application/json

payment

object

required

The payment's fields. They are not documented yet.

Response

201

The new payment's code as payment.payment_id, with object and message.

Guides

API reference

Authorizations

Path Parameters

Body

Response