GET Payments

Returns a list of Payment summary records. Use ForInvoiceId={InvoiceId} to retrieve payments for a single invoice. Note: TransactionType filter will be ignored if ForInvoiceId is specified.

Request Information

URI Parameters

Name Description Type Additional information
WsAccessKey The Web Service access key for this user and file which allows access to the API for the associated file (found in File - Settings). Using OAuth authentication mechanism is the preferred method to allow API access. string

Optional. Legacy authentication method and only required if not using OAuth. OAuth is preferred.
FileId Specifies the file id of the file to perform the operation upon. integer

Required
Page Specifies the page number of the result set to return. integer

None.
PageSize Specifies the number of records on each page of results. Maximum page size is 100. Defaults to 25 if not specified. integer

None.
LastModifiedFromDate Filter records with LastModifiedDate greater than or equal to a date in UTC (must also specifiy LastModifiedToDate). date

None.
LastModifiedToDate Filter records with LastModifiedDate less than or equal to a date in UTC (must also specifiy LastModifiedFromDate). date

None.
ForInvoiceId Filter records with a matching Invoice Id in the For Invoice Id field. string

None.
ClearedFromDate Filter records with DateCleared greater than or equal to a date (must also specifiy DateClearedToDate). date

None.
ClearedToDate Filter records with DateCleared less than or equal to a date (must also specifiy DateClearedFromDate). date

None.
TransactionType Filter records with the specified TransactionType (SP = Sale Payment, PP = Purchase Payment). string

None.
PaymentFromDate Filter records with PaymentDate greater than or equal to a date (must also specifiy PaymentDateTo). If PaymentFromDate and/or PaymentToDate are not specified, the default period queried is the last month. string

None.
PaymentToDate Filter records with PaymentDate less than or equal to a date (must also specifiy PaymentDateFrom). If PaymentFromDate and/or PaymentToDate are not specified, the default period queried is the last month. string

None.
PaymentAccountId Filter records with PaymentAccountId equal to the specified value. string

None.

Body Parameters

None.

Response Information

Resource Description

PaymentTransactionSummaryResponse
Name Description Type Additional information
PaymentTransactions A list of payment transactions. Collection of PaymentTransactionSummary

None.
_links Hypermedia links. Contains contextual links to possible next actions related to this resource. Only present in responses. This data is not to be sent to the server. Collection of Link

None.

Response Formats

application/json, text/json

Sample: 
{
  "PaymentTransactions": [
    {
      "TransactionId": 6,
      "TransactionDate": "2024-11-13T13:00:00Z",
      "TransactionType": "SP",
      "PaymentAccountId": 1387,
      "TotalAmount": 100.0,
      "FeeAmount": 10.0,
      "Summary": "Payment Test",
      "Reference": null,
      "ClearedDate": null,
      "Currency": "AUD",
      "AutoPopulateFxRate": false,
      "FxRate": 0.0,
      "CreatedDateUtc": "2024-11-13T19:21:11.8807723Z",
      "LastModifiedDateUtc": "2024-11-20T19:21:11.8807723Z",
      "LastUpdatedId": "ASSAAACYUZ=",
      "RequiresFollowUp": false,
      "_links": [
        {
          "rel": "detail",
          "href": "https://api.saasu.com/Payment/6?FileId=123",
          "method": "GET",
          "title": null
        }
      ]
    }
  ],
  "_links": [
    {
      "rel": "self",
      "href": "https://api.saasu.com/Payments?FileId=123",
      "method": "GET",
      "title": null
    },
    {
      "rel": "next",
      "href": "https://api.saasu.com/Payments?FileId=123&Page=2&PageSize=25",
      "method": "GET",
      "title": null
    }
  ]
}

application/xml, text/xml

Sample: 
<PaymentTransactionSummaryResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <_links>
    <Link>
      <rel>self</rel>
      <href>https://api.saasu.com/Payments?FileId=123</href>
      <method>GET</method>
    </Link>
    <Link>
      <rel>next</rel>
      <href>https://api.saasu.com/Payments?FileId=123&amp;Page=2&amp;PageSize=25</href>
      <method>GET</method>
    </Link>
  </_links>
  <PaymentTransactions>
    <PaymentTransactionSummary>
      <_links>
        <Link>
          <rel>detail</rel>
          <href>https://api.saasu.com/Payment/6?FileId=123</href>
          <method>GET</method>
        </Link>
      </_links>
      <TransactionId>6</TransactionId>
      <TransactionDate>2024-11-13T13:00:00Z</TransactionDate>
      <TransactionType>SP</TransactionType>
      <PaymentAccountId>1387</PaymentAccountId>
      <TotalAmount>100</TotalAmount>
      <FeeAmount>10</FeeAmount>
      <Summary>Payment Test</Summary>
      <Reference xsi:nil="true" />
      <ClearedDate xsi:nil="true" />
      <Currency>AUD</Currency>
      <AutoPopulateFxRate>false</AutoPopulateFxRate>
      <FxRate>0</FxRate>
      <CreatedDateUtc>2024-11-13T19:21:11.8807723Z</CreatedDateUtc>
      <LastModifiedDateUtc>2024-11-20T19:21:11.8807723Z</LastModifiedDateUtc>
      <LastUpdatedId>ASSAAACYUZ=</LastUpdatedId>
      <RequiresFollowUp>false</RequiresFollowUp>
    </PaymentTransactionSummary>
  </PaymentTransactions>
</PaymentTransactionSummaryResponse>