Home

Download this help site
(PDF 82MB)

Download

PaymentAllocations API V2 call 

Icon

Wild Apricot's API is intended for use by developers with technical expertise. If you need assistance, we provide support via email or through our Developers forum.

You can use the PaymentAllocations API call to retrieve information describing how payments are allocated among invoices. A single payment, for example, might be allocated to multiple invoices, and multiple payments can be allocated to a single invoice.

Retrieving information for a particular invoice

Syntax

Example:

Retrieving information for a particular payment

Syntax

Example:

Parameters

The following parameters are used within the PaymentAllocations API call:

Variable

Description

{baseAPIaddress}

The base address of the API. For more information, see API access options.

{accountID}

The account identifier that appears on the Account and billing screen and is returned by the Accounts API call.

{invoiceID}The unique identifier for an invoice. Invoices IDs are returned by the Invoices API call.
{paymentID}The unique identifier for a payment. Payment IDs are returned by the Payments API call.
Icon

Each API call must include an authentication information that verifies your account and prevents others from accessing your data. For more information, see Authenticating API access from a 3rd-party server or application or Authenticating API access from a Wild Apricot site page.

Response fields

The PaymentAllocations API call retrieves the following information for each payment allocation.

Field

Description

IDThe unique identifier of the payment allocation.
ValueThe value of the payment allocation.
InvoiceThe ID and URL of the invoice to which the payment is being allocated.
PaymentThe ID and URL of the payment being allocated.

Sample JSON response

Sample XML response

 

 

 

On this page:   

See also:

  • No labels