> ## Documentation Index
> Fetch the complete documentation index at: https://exsited.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a purchase payment

> Records a payment to a supplier and returns it under `purchase_payment`.

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.

> [!NOTE]
>
> The SDK samples get their client from credentials your app registers once when it starts, as shown in [Authentication](https://exsited.mintlify.site/authentication.md#set-up-a-client). 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](https://exsited.mintlify.site/api-reference/authentication/get-an-access-token.md). To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its `-d` payload.


## OpenAPI

````yaml POST /purchase_payments
openapi: 3.1.0
info:
  title: Exsited API
  version: v4
servers:
  - url: https://{host}/api/v4
    variables:
      host:
        default: your-api-host.example.com
        description: Your Exsited API host name, without https://.
security:
  - bearerAuth: []
tags:
  - name: Authentication
  - name: Accounts
  - name: Account emails
  - name: Account groups
  - name: Communications
  - name: Communication profiles
  - name: Orders
  - name: Quote orders
  - name: Express
  - name: Usages
  - name: Sales reps
  - name: Gift certificates
  - name: Invoices
  - name: Pro-forma invoices
  - name: Payments
  - name: Refunds
  - name: Credit notes
  - name: Credit note applications
  - name: Reconciliations
  - name: Items
  - name: Inventory adjustments
  - name: Units of measurement
  - name: Zones
  - name: Shipping packages
  - name: Shipping rules
  - name: Fulfillment profiles
  - name: Fulfillment terms
  - name: Item fulfillments
  - name: Item receipts
  - name: Bookings
  - name: Rental assets
  - name: Return merchandise authorisations
  - name: Purchase orders
  - name: Purchase invoices
  - name: Purchase payments
  - name: Purchase refunds
  - name: Purchase credit notes
  - name: Purchase credit note applications
  - name: Purchase express
  - name: Return vendor authorizations
  - name: ABA files
  - name: Receive terms
  - name: Labours
  - name: Tasks
  - name: Timesheets
  - name: Milestones
  - name: Employees
  - name: Departments
  - name: Designations
  - name: Teams
  - name: Time periods
  - name: Workflows
  - name: Workflow settings
  - name: Events
  - name: Custom events
  - name: System events
  - name: Approvals
  - name: Approval profiles
  - name: Approval user groups
  - name: Alerts
  - name: Alert responsibility settings
  - name: Alert responsibilities
  - name: Action scripts
  - name: Note groups
  - name: Note attachments
  - name: Instance settings
  - name: Accounting codes
  - name: Additional codes
  - name: Billing periods
  - name: Charging periods
  - name: Pricing periods
  - name: Invoice terms
  - name: Days of the month
  - name: Countries
  - name: Salutations
  - name: Document templates
  - name: Email templates
  - name: Roles
  - name: Operators
  - name: Operator groups
  - name: User settings
  - name: Custom attributes
  - name: Custom components
  - name: Custom features
  - name: Custom fields
  - name: Custom forms
  - name: Attribute attachments
  - name: Portal
  - name: Integration connections
  - name: External databases
  - name: Reports
  - name: Applications
  - name: Organisation
  - name: Child organisations
  - name: Webhooks
paths:
  /purchase_payments:
    post:
      tags:
        - Purchase payments
      summary: Create a purchase payment
      description: >-
        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.
      operationId: purchase_payments_create_purchase_payment
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                purchase_payment:
                  type: object
                  properties:
                    payment_method_applications:
                      type: array
                      items:
                        type: object
                        properties:
                          amount:
                            type: string
                            description: >-
                              The amount paid with this processor, such as
                              `1.00`.
                          payment_processor:
                            type: string
                            description: >-
                              The `id` of a payment processor from the payment
                              processor settings.
                      description: How the payment is made.
                    purchase_invoice_applications:
                      type: array
                      items:
                        type: object
                        properties:
                          purchase_invoice:
                            type: string
                            description: The purchase invoice's `id`.
                          amount:
                            type: string
                            description: The amount, as a decimal string such as `1.00`.
                      description: >-
                        The purchase invoices this payment pays, and how much
                        goes to each.
                    credit_note_applications:
                      type: array
                      items:
                        type: object
                        properties:
                          purchase_credit_note:
                            type: string
                            description: The purchase credit note's `id`.
                          amount:
                            type: string
                            description: The amount, as a decimal string such as `1.00`.
                      description: Purchase credit notes to spend as part of this payment.
              required:
                - purchase_payment
            example:
              purchase_payment:
                payment_method_applications:
                  - amount: '1.00'
                    payment_processor: PROC-0001
                purchase_invoice_applications:
                  - purchase_invoice: PI-0001
                    amount: '1.00'
      responses:
        '201':
          description: The new purchase payment, under `purchase_payment`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PurchasePaymentCreatedResponse'
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            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"
                    }
                  ]
                }
              }'
        - lang: python
          label: Python
          source: |
            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)
        - lang: javascript
          label: JavaScript
          source: >
            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);
        - lang: php
          label: PHP
          source: |
            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);
        - lang: java
          label: Java
          source: >
            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());
        - lang: csharp
          label: .NET
          source: >
            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);
        - lang: dart
          label: Dart
          source: >
            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);
        - lang: go
          label: Go
          source: "import (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\n\texsited \"github.com/exsited/exsited-sdk-go/v4\"\n)\n\nclient, err := exsited.BuildClient(nil)\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer client.Close()\n\nresponse, err := client.PurchasePayments().CreatePurchasePayment(context.Background(), map[string]any{\n\t\"purchase_payment\": map[string]any{\n\t\t\"payment_method_applications\": []any{\n\t\t\tmap[string]any{\n\t\t\t\t\"amount\":            \"1.00\",\n\t\t\t\t\"payment_processor\": \"PROC-0001\",\n\t\t\t},\n\t\t},\n\t\t\"purchase_invoice_applications\": []any{\n\t\t\tmap[string]any{\n\t\t\t\t\"purchase_invoice\": \"PI-0001\",\n\t\t\t\t\"amount\":           \"1.00\",\n\t\t\t},\n\t\t},\n\t},\n}, nil)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Println(response.Map)\n"
components:
  schemas:
    PurchasePaymentCreatedResponse:
      type: object
      properties:
        purchase_payment:
          $ref: '#/components/schemas/PurchasePayments'
    PurchasePayments:
      type: object
      properties:
        account:
          $ref: '#/components/schemas/PurchasePaymentsAccount'
        activity_logs:
          type: array
          items:
            $ref: '#/components/schemas/PurchasePaymentsActivityLog'
        code:
          type: string
        created_by:
          $ref: '#/components/schemas/PurchasePaymentsCreatedBy'
        created_on:
          type: string
        credit_note_applications:
          type: array
          items:
            $ref: '#/components/schemas/PurchasePaymentsCreditNoteApplication'
        credit_note_total:
          type: string
        currency:
          $ref: '#/components/schemas/PurchasePaymentsCurrency'
        custom_attributes:
          type: array
          items: {}
        custom_objects:
          type: array
          items: {}
        href:
          type: string
        id:
          type: string
        last_updated_by:
          type: string
        last_updated_on:
          type: string
        object:
          type: string
        origin:
          type: string
        paid_total:
          type: string
        payment_date:
          type: string
        payment_method_applications:
          type: array
          items:
            $ref: '#/components/schemas/PurchasePaymentsPaymentMethodApplication'
        payment_note:
          type: string
        payment_reference: {}
        purchase_credit_applied:
          type: array
          items: {}
        purchase_invoice_applications:
          type: array
          items:
            $ref: '#/components/schemas/PurchasePaymentsPurchaseInvoiceApplication'
        purchase_invoices:
          type: array
          items: {}
        purchase_order_id:
          type: string
        purchase_payment_applied:
          type: array
          items: {}
        purchase_payment_date:
          type: string
        purchase_payment_note:
          type: string
        status:
          type: string
        total_applied:
          type: string
        uuid:
          type: string
        version:
          type: integer
    PurchasePaymentsAccount:
      type: object
      properties:
        code:
          type: string
        href:
          type: string
        id:
          type: string
        name:
          type: string
        object:
          type: string
    PurchasePaymentsActivityLog:
      type: object
      properties:
        activity:
          type: string
    PurchasePaymentsCreatedBy:
      type: object
      properties:
        name:
          type: string
        object:
          type: string
    PurchasePaymentsCreditNoteApplication:
      type: object
      properties:
        amount:
          type: string
        purchase_credit_note:
          $ref: >-
            #/components/schemas/PurchasePaymentsCreditNoteApplicationPurchaseCreditNote
    PurchasePaymentsCurrency:
      type: object
      properties:
        code:
          type: string
        href:
          type: string
        id:
          type: string
        name:
          type: string
        object:
          type: string
    PurchasePaymentsPaymentMethodApplication:
      type: object
      properties:
        amount:
          type: string
        payment_method:
          $ref: '#/components/schemas/PurchasePaymentsPaymentMethodApplicationDetail'
        payment_processor:
          $ref: >-
            #/components/schemas/PurchasePaymentsPaymentMethodApplicationPaymentProcessor
        reference:
          type: string
    PurchasePaymentsPurchaseInvoiceApplication:
      type: object
      properties:
        applied:
          type: string
        due_date:
          type: string
        issue_date:
          type: string
        outstanding:
          type: string
        purchase_invoice:
          $ref: >-
            #/components/schemas/PurchasePaymentsPurchaseInvoiceApplicationDetail
        total:
          type: string
    PurchasePaymentsCreditNoteApplicationPurchaseCreditNote:
      type: object
      properties:
        code:
          type: string
        href:
          type: string
        id:
          type: string
        object:
          type: string
    PurchasePaymentsPaymentMethodApplicationDetail:
      type: object
      properties:
        object:
          type: string
        id:
          type: string
        name:
          type: string
        href:
          type: string
    PurchasePaymentsPaymentMethodApplicationPaymentProcessor:
      type: object
      properties:
        object:
          type: string
        id:
          type: string
        name:
          type: string
        href:
          type: string
    PurchasePaymentsPurchaseInvoiceApplicationDetail:
      type: object
      properties:
        code:
          type: string
        href:
          type: string
        id:
          type: string
        object:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An access token from `POST /api/v4/oauth2/token`. The SDKs get and renew
        it for you.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.