> ## 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. # List purchase payments > Returns one page of purchase payments. Lists the purchase payments on the account, one page at a time, under `data`. Pass `pagination.next_cursor` back as `cursor` to read the next page. Other fields filter the list as `filter_` or `filter__`. > [!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). ## OpenAPI ````yaml GET /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: get: tags: - Purchase payments summary: List purchase payments description: >- Lists the purchase payments on the account, one page at a time, under `data`. Pass `pagination.next_cursor` back as `cursor` to read the next page. Other fields filter the list as `filter_` or `filter__`. operationId: purchase_payments_get_purchase_payments parameters: - name: limit in: query required: false description: The most records to return on one page. schema: type: integer example: 20 - name: cursor in: query required: false description: >- The `next_cursor` value from the previous page, to read the next one. schema: type: string - name: sort in: query required: false description: >- The field to sort by. Prefix it with `-` for descending order, such as `-created_on`. schema: type: string example: '-created_on' responses: '200': description: One page of purchase payments. content: application/json: schema: $ref: '#/components/schemas/PurchasePaymentList' x-codeSamples: - lang: bash label: cURL source: |- curl -X GET "$EXSITED_BASE_URL/api/v4/purchase_payments?limit=20" \ -H "Authorization: Bearer $ACCESS_TOKEN" - lang: python label: Python source: > from exsited import build_client client = build_client() response = client.purchase_payments.get_purchase_payments({"limit": 20}) print(response.data) - lang: javascript label: JavaScript source: > import {buildClient} from 'exsited'; const client = await buildClient(); const response = await client.purchasePayments.getPurchasePayments({limit: 20}); console.log(response.data); - lang: php label: PHP source: > use Exsited\Client\ClientRegistry; $client = ClientRegistry::buildClient(); $response = $client->purchasePayments->getPurchasePayments(['limit' => 20]); 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.PurchasePaymentList; import java.util.Map; ExsitedClient client = ClientRegistry.buildClient(); ApiResponse response = client.purchasePayments().getPurchasePayments( Map.of("limit", 20)); System.out.println(response.getMap()); - lang: csharp label: .NET source: > using Exsited.Client; await using var client = ExsitedClient.BuildClient(); var response = await client.PurchasePayments.GetPurchasePaymentsAsync(new Dictionary { ["limit"] = 20 }); Console.WriteLine(response.Json); - lang: dart label: Dart source: | import 'package:exsited/exsited.dart'; final client = buildClient(); final response = await client.purchasePayments.getPurchasePayments( queryParams: {'limit': 20}, ); 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().GetPurchasePayments(context.Background(), map[string]any{\"limit\": 20}, nil)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Println(response.Map)\n" components: schemas: PurchasePaymentList: type: object properties: data: type: array items: $ref: '#/components/schemas/PurchasePayment' object: type: string pagination: $ref: '#/components/schemas/PurchasePaymentPagination' url: type: string PurchasePayment: type: object properties: account: $ref: '#/components/schemas/PurchasePaymentAccount' code: type: string created_by: $ref: '#/components/schemas/PurchasePaymentCreatedBy' created_on: type: string credit_note_applications: type: array items: $ref: '#/components/schemas/PurchasePaymentCreditNoteApplication' credit_note_total: type: string currency: $ref: '#/components/schemas/PurchasePaymentCurrency' custom_attributes: type: array items: {} custom_objects: type: array items: {} href: type: string id: type: string last_updated_by: $ref: '#/components/schemas/PurchasePaymentLastUpdatedBy' 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/PurchasePaymentPaymentMethodApplication' payment_note: type: string payment_reference: {} purchase_credit_applied: type: array items: {} purchase_invoice_applications: type: array items: $ref: '#/components/schemas/PurchasePaymentPurchaseInvoiceApplication' 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 PurchasePaymentPagination: type: object properties: limit: type: integer description: The page size the API applied. has_more: type: boolean description: >- Whether another page follows. Trust this over `next_cursor`, which can be set on the last page. next_cursor: type: string description: Pass as `cursor` to read the next page. prev_cursor: type: string description: The cursor of the previous page. links: $ref: '#/components/schemas/PurchasePaymentPaginationLinks' PurchasePaymentAccount: type: object properties: code: type: string href: type: string id: type: string name: type: string object: type: string PurchasePaymentCreatedBy: type: object properties: name: type: string object: type: string PurchasePaymentCreditNoteApplication: type: object properties: amount: type: string purchase_credit_note: $ref: >- #/components/schemas/PurchasePaymentCreditNoteApplicationPurchaseCreditNote PurchasePaymentCurrency: type: object properties: code: type: string href: type: string id: type: string name: type: string object: type: string PurchasePaymentLastUpdatedBy: type: object properties: name: type: string object: type: string PurchasePaymentPaymentMethodApplication: type: object properties: amount: type: string payment_method: $ref: '#/components/schemas/PurchasePaymentPaymentMethodApplicationDetail' payment_processor: $ref: >- #/components/schemas/PurchasePaymentPaymentMethodApplicationPaymentProcessor reference: type: string PurchasePaymentPurchaseInvoiceApplication: type: object properties: applied: type: string due_date: type: string issue_date: type: string outstanding: type: string purchase_invoice: $ref: '#/components/schemas/PurchasePaymentPurchaseInvoiceApplicationDetail' total: type: string PurchasePaymentPaginationLinks: type: object properties: next: type: string prev: type: string PurchasePaymentCreditNoteApplicationPurchaseCreditNote: type: object properties: code: type: string href: type: string id: type: string object: type: string PurchasePaymentPaymentMethodApplicationDetail: type: object properties: object: type: string id: type: string name: type: string href: type: string PurchasePaymentPaymentMethodApplicationPaymentProcessor: type: object properties: object: type: string id: type: string name: type: string href: type: string PurchasePaymentPurchaseInvoiceApplicationDetail: 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.