POST Payment

Insert a Payment transaction.

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

Body Parameters

PaymentTransaction
Name Description Type Additional information
Notes Custom user supplied notes about the payment. string

None.

PaymentItems Invoices that are paid as part of the payment. Collection of PaymentItem

Required

TransactionId The Id of the transaction. integer

None.

TransactionDate The date the payment was received or made. date

Required

TransactionType Sale Payment(SP) or Purchase Payment(PP) string

Required

PaymentAccountId Bank Account ID used to receive or pay funds. integer

Required

TotalAmount Total payment amount received or paid. decimal number

None.

FeeAmount Fee amount associated with the payment. decimal number

None.

Summary Summary of the payment. string

None.

Reference Payment reference identifier. string

None.

ClearedDate The date the payment was cleared. date

None.

Currency Currency code of the payment eg: AUD or USD. Defaults to base currency for the file if not supplied or invalid value supplied. string

None.

AutoPopulateFxRate Determines with if FxRate is automatically populated using the Saasu FX Feed. boolean

None.

FxRate If AutoPopulateFxRate is False then the specified FxRate will be used. decimal number

None.

CreatedDateUtc The date and time when this payment was created in UTC. date

None.

LastModifiedDateUtc The date and time when this payment last modified in UTC. date

None.

LastUpdatedId Used for checking concurreny when performing updates. string

None.

RequiresFollowUp Indicates whether this payment requires follow up. boolean

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.

Request Formats

application/json, text/json

Sample:
{
  "Notes": "payment notes",
  "PaymentItems": [
    {
      "InvoiceTransactionId": 1234,
      "AmountPaid": 120.0
    },
    {
      "InvoiceTransactionId": 5678,
      "AmountPaid": 150.0
    }
  ],
  "TransactionId": 324,
  "TransactionDate": "2017-12-10T13:00:00Z",
  "TransactionType": null,
  "PaymentAccountId": 1858,
  "TotalAmount": 10.0,
  "FeeAmount": 0.0,
  "Summary": "Payment for invoice 1",
  "Reference": "Toy inv",
  "ClearedDate": "2017-12-11T00:00:00+11:00",
  "Currency": "AUD",
  "AutoPopulateFxRate": false,
  "FxRate": 0.0,
  "CreatedDateUtc": "2017-12-10T22:00:52.7326698Z",
  "LastModifiedDateUtc": "2017-12-10T22:00:52.7326698Z",
  "LastUpdatedId": null,
  "RequiresFollowUp": false,
  "_links": []
}

application/xml, text/xml

Sample:
<PaymentTransaction xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <_links />
  <TransactionId>324</TransactionId>
  <TransactionDate>2017-12-10T13:00:00Z</TransactionDate>
  <PaymentAccountId>1858</PaymentAccountId>
  <TotalAmount>10</TotalAmount>
  <FeeAmount>0</FeeAmount>
  <Summary>Payment for invoice 1</Summary>
  <Reference>Toy inv</Reference>
  <ClearedDate>2017-12-11T00:00:00+11:00</ClearedDate>
  <Currency>AUD</Currency>
  <AutoPopulateFxRate>false</AutoPopulateFxRate>
  <FxRate>0</FxRate>
  <CreatedDateUtc>2017-12-10T22:00:52.7326698Z</CreatedDateUtc>
  <LastModifiedDateUtc>2017-12-10T22:00:52.7326698Z</LastModifiedDateUtc>
  <LastUpdatedId xsi:nil="true" />
  <RequiresFollowUp>false</RequiresFollowUp>
  <Notes>payment notes</Notes>
  <PaymentItems>
    <PaymentItem>
      <InvoiceTransactionId>1234</InvoiceTransactionId>
      <AmountPaid>120.00</AmountPaid>
    </PaymentItem>
    <PaymentItem>
      <InvoiceTransactionId>5678</InvoiceTransactionId>
      <AmountPaid>150.00</AmountPaid>
    </PaymentItem>
  </PaymentItems>
</PaymentTransaction>

Response Information

Resource Description

InsertPaymentResult
Name Description Type Additional information
InsertedEntityId The Id/Key of the payment that was created/inserted. integer

None.

LastUpdatedId The unique identifier generated as part of the update. This value is required when submitting subsequent update to prevent concurrency errors. string

None.

UtcLastModified The date and time this resource was modified in UTC. date

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:
{
  "InsertedEntityId": 321,
  "LastUpdatedId": "AAAKyf=",
  "UtcLastModified": "2017-11-30T22:00:52.8420513Z",
  "_links": [
    {
      "rel": "self",
      "href": "https://api.saasu.com/Payment/321?FileId=123",
      "method": "POST",
      "title": null
    },
    {
      "rel": "list",
      "href": "https://api.saasu.com/Payments?FileId=123",
      "method": "GET",
      "title": null
    },
    {
      "rel": "update",
      "href": "https://api.saasu.com/Payment/321?FileId=123",
      "method": "PUT",
      "title": null
    },
    {
      "rel": "delete",
      "href": "https://api.saasu.com/Payment/321?FileId=123",
      "method": "DELETE",
      "title": null
    }
  ]
}

application/xml, text/xml

Sample:
<InsertPaymentResult 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/Payment/321?FileId=123</href>
      <method>POST</method>
    </Link>
    <Link>
      <rel>list</rel>
      <href>https://api.saasu.com/Payments?FileId=123</href>
      <method>GET</method>
    </Link>
    <Link>
      <rel>update</rel>
      <href>https://api.saasu.com/Payment/321?FileId=123</href>
      <method>PUT</method>
    </Link>
    <Link>
      <rel>delete</rel>
      <href>https://api.saasu.com/Payment/321?FileId=123</href>
      <method>DELETE</method>
    </Link>
  </_links>
  <LastUpdatedId>AAAKyf=</LastUpdatedId>
  <UtcLastModified>2017-11-30T22:00:52.8420513Z</UtcLastModified>
  <InsertedEntityId>321</InsertedEntityId>
</InsertPaymentResult>