RArailz
Aging
Aging Reports

GET /apAging

Changed on

Gets a range of AP aging reports for a business.

Request

  • Base URL
    https://api.railz.ai
  • Auth
    HTTP bearer

Query parameters

businessNamestring required
serviceName'freshbooks' | 'quickbooks' | 'quickbooksDesktop' | 'dynamicsBusinessCentral' required
startDatestring

Transaction date greater than or equal to parameter in the format: YYYY-MM-DD.

endDatestring

Transaction date less than or equal to parameter in the format: YYYY-MM-DD.

offsetnumber

The offset is the position in the dataset of a particular record.

limitnumber
Example:100

This is the size of the results set you would like (default: 100).

orderBystring
reportFrequency'month' | 'quarter' | 'year' required

Response

countinteger required

Example response

{
  "count": 1,
  "reports": [
    {
      "meta": {
        "reportId": [
          "5fad8a342a88364234392fb5"
        ],
        "serviceName": "xero",
        "businessName": "Railz",
        "startDate": "2020-11-25T01:02:03Z",
        "endDate": "2020-11-30T01:02:03Z",
        "createdAt": "2020-11-25T01:02:03Z",
        "updatedAt": "2020-11-30T01:02:03Z",
        "reportFrequency": "month"
      },
      "data": [
        {
          "vendorRef": {
            "id": "240",
            "name": "Railz"
          },
          "current": 50000,
          "dpd30": 25000,
          "dpd60": 25000,
          "dpd90": 60000,
          "dpd90+": 90000,
          "total": 200000,
          "currencyRef": {
            "id": "CAD",
            "name": "Canadian Dollar",
            "symbol": "USD,CAD"
          }
        }
      ]
    }
  ]
}

Changes

  • 1383b9a47ac9Revision changes
    • info

      api tag Aging added

  • 5cdfae3fa1faRevision changes
    • breaking

      the response property //// became optional for the status

    • breaking

      the response property //// became optional for the status

    • warning

      added the new dynamics365Finance enum value to the /// response property for the response status

    • warning

      added the new dynamics365Finance enum value to the /// response property for the response status

    • warning

      added the new dynamicsBusinessCentral enum value to the /// response property for the response status

    • warning

      added the new dynamicsBusinessCentral enum value to the /// response property for the response status

    • warning

      added the new freshbooks enum value to the /// response property for the response status

    • warning

      added the new freshbooks enum value to the /// response property for the response status

    • warning

      added the new myob enum value to the /// response property for the response status

    • warning

      added the new myob enum value to the /// response property for the response status

    • warning

      added the new oracleNetsuite enum value to the /// response property for the response status

    • warning

      added the new oracleNetsuite enum value to the /// response property for the response status

    • warning

      added the new quickbooks enum value to the /// response property for the response status

    • warning

      added the new quickbooks enum value to the /// response property for the response status

    • warning

      added the new quickbooksDesktop enum value to the /// response property for the response status

    • warning

      added the new quickbooksDesktop enum value to the /// response property for the response status

    • warning

      added the new sageBusinessCloud enum value to the /// response property for the response status

    • warning

      added the new sageBusinessCloud enum value to the /// response property for the response status

    • warning

      added the new sageIntacct enum value to the /// response property for the response status

    • warning

      added the new sageIntacct enum value to the /// response property for the response status

    • warning

      added the new wave enum value to the /// response property for the response status

    • warning

      added the new wave enum value to the /// response property for the response status

    • warning

      added the new xero enum value to the /// response property for the response status

    • warning

      added the new xero enum value to the /// response property for the response status

    • warning

      added the new zohoBooks enum value to the /// response property for the response status

    • warning

      added the new zohoBooks enum value to the /// response property for the response status

    • info

      added the new enum value dynamicsBusinessCentral to the query request parameter serviceName

    • info

      added the new enum value freshbooks to the query request parameter serviceName

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status