Skip to content

GetPaymentsByStatusDate

Lists the payments of one company, the money it paid to suppliers and other entities against their bills, by status: the drafts created, the payments approved or the payments finalized in a date range. Use it to pick up the payments approved or finalized since your last call, then read each one, with the bills it pays, with GetTransaction. Receipts, the money received against invoices, are not listed. Payments are described on the Receipt or payment page.

How to sign in and read the response: Authentication, Responses.

GET /api/v1/GetPaymentsByStatusDate?CompID=3&Status=Approved&FromDate=2026-10-01&ToDate=2026-10-08
Token: your-token
Parameter Required Meaning
CompID Yes The ID of the company that made the payments, a whole number.
Status Yes Draft, Approved or Finalised. Capitals do not matter. See Status and dates.
FromDate Yes The start of the range, as yyyy-MM-dd, or yyyy-MM-ddTHH:mm:ss for a time, in UTC. Included.
ToDate Yes The end of the range, in the same form. Included. At most 365 days after FromDate.

Send dates as yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss: other forms depend on the server’s regional settings. See Dates.

Status chooses both the payments and the date the range applies to (for the statuses, see How a receipt moves on):

Status Lists the payments that are The range applies to
Draft Not approved yet. When the payment was created.
Approved Approved, and not finalized yet. When the payment was approved.
Finalised Finalized. When the payment was finalized.

So a payment is listed under one status at a time: an approved payment no longer appears under Draft, and a finalized one no longer appears under Approved. A payment that is reset to draft appears under Draft again.

The dates are times, in UTC. A date without a time is the start of that day, so ToDate=2026-10-08 stops at midnight at the start of 8 October. To include the whole day, send ToDate=2026-10-08T23:59:59 or the next day.

Rule Info when it fails
The Token header holds a valid token. Token missing in header, Token invalid or expired, or another answer listed in Login token
The user is a system administrator with API access. API User must be SysAdmin with API Access
Status has a value. Status is required
FromDate has a value. FromDate is required
ToDate has a value. ToDate is required
CompID is more than 0. CompID is invalid
Status is one of the three values. Invalid Status. Status must be one of the following: Draft, Approved, Finalised
FromDate is a date. FromDate is not valid
ToDate is a date. ToDate is not valid
ToDate is not before FromDate. ToDate must be later than FromDate
The dates are at most 365 days apart. Days between FromDate and ToDate cannot exceed 365

TrakIT removes spaces from the dates before it reads them, so write a time with the T: 2026-10-08 23:59:59 is refused.

On success, Code is 1, RetInfo is the list, in order of ID, and RowsAffected is the number of payments in it. When no payment matches, including when no company has that CompID, the list is empty: Code is still 1 and RowsAffected is 0.

{
"Code": 1,
"Info": "",
"RetInfo": [
{ "ID": 60218, "Date": "2026-10-06T00:00:00", "Curr": "USD", "Amount": 1150.00, "Seq": "HQ20260012" },
{ "ID": 60231, "Date": "2026-10-07T00:00:00", "Curr": "EUR", "Amount": 420.00, "Seq": "HQ20260013" }
],
"RowsAffected": 2,
"Scalar": null,
"Identity": 0
}
Field Meaning
ID The payment’s ID. Use it with GetTransaction.
Date The payment’s Transaction Date, as a date and time at midnight.
Curr The payment’s currency.
Amount The amount paid.
Seq The payment’s Sequence Number, given on approval: the company’s code, the year and a running number. null for a draft.
  • Send every parameter: without one of them the request does not reach the endpoint, and TrakIT answers with HTTP status 404 (see Errors).