GET
/
Query
/
payouts
/
org
/
{orgId}
curl --request GET \
  --url https://api-sandbox.payabli.com/api/Query/payouts/org/{orgId} \
  --header 'requestToken: <api-key>'
{
  "Summary": {
    "totalRecords": 2,
    "totalAmount": 77.22,
    "totalNetAmount": 77.22,
    "totalPages": 2,
    "pageSize": 20,
    "pageIdentifier": "null",
    "totalPaid": 123,
    "totalPaidAmount": 123,
    "totalCanceled": 123,
    "totalCanceledAmount": 123,
    "totalCaptured": 123,
    "totalCapturedAmount": 123,
    "totalAuthorized": 123,
    "totalAuthorizedAmount": 123,
    "totalProcessing": 123,
    "totalProcessingAmount": 123,
    "totalOpen": 123,
    "totalOpenAmount": 123
  },
  "Records": [
    {
      "IdOut": 236,
      "CreatedAt": "2022-07-01 15:00:01",
      "Vendor": {
        "vendorNumber": "1234",
        "name1": "Herman's Coatings",
        "name2": "Herman's Coating Supply Company, LLC",
        "ein": "123456789",
        "phone": "212-555-1234",
        "email": "example@email.com",
        "address1": "123 Ocean Drive",
        "address2": "Suite 400",
        "city": "Bristol",
        "state": "GA",
        "zip": "31113",
        "country": "US",
        "mcc": "7777",
        "locationCode": "LOC123",
        "contacts": [
          {
            "contactName": "Herman Martinez",
            "contactEmail": "example@email.com",
            "contactTitle": "Owner",
            "contactPhone": "3055550000"
          }
        ],
        "billingData": {
          "id": 123,
          "bankName": "Country Bank",
          "routingAccount": "123123123",
          "accountNumber": "1XXXXXX3123",
          "typeAccount": "Checking",
          "bankAccountHolderName": "Gruzya Adventure Outfitters LLC",
          "bankAccountHolderType": "Business",
          "bankAccountFunction": 0
        },
        "paymentMethod": {
          "method": "managed"
        },
        "vendorStatus": 1,
        "vendorId": "1340",
        "enrollmentStatus": null,
        "summary": {
          "pendingBills": 123,
          "inTransitBills": 123,
          "paidBills": 123,
          "overdueBills": 123,
          "totalBills": 123,
          "pendingBillsAmount": 123,
          "inTransitBillsAmount": 123,
          "paidBillsAmount": 123,
          "overdueBillsAmount": 123,
          "totalBillsAmount": 123
        },
        "paypointLegalname": "Sunshine Services, LLC",
        "paypointDbaname": "Sunshine Gutters",
        "paypointEntryname": "d193cf9a46",
        "parentOrgName": "PropertyManager Pro",
        "createdDate": "2022-07-01 15:00:01",
        "lastUpdated": "2022-07-01 15:00:01",
        "remitAddress1": "123 Walnut Street",
        "remitAddress2": "Suite 900",
        "remitCity": "Miami",
        "remitState": "FL",
        "remitZip": "31113",
        "remitCountry": "US",
        "payeeName1": "<string>",
        "payeeName2": "<string>",
        "customerVendorAccount": "123-456",
        "internalReferenceId": 123,
        "additionalData": {
          "key1": "value1",
          "key2": "value2",
          "key3": "value3"
        },
        "externalPaypointId": "Paypoint-100"
      },
      "Comments": "Deposit for materials",
      "ParentOrgName": "PropertyManager Pro",
      "BatchNumber": "BT-2024321",
      "PaypointDbaname": "Sunshine Gutters",
      "PaypointLegalname": "Sunshine Services, LLC",
      "TotalAmount": 110.25,
      "NetAmount": 3762.87,
      "FeeAmount": 10.25,
      "Source": "api",
      "PaymentId": "2345667-ddd-fff",
      "Status": 1,
      "PaymentStatus": "Processed",
      "CheckNumber": "12345",
      "CheckData": {
        "ftype": "pdf",
        "filename": "my-doc.pdf",
        "furl": "https://mysite.com/my-doc.pdf",
        "fContent": "TXkgdGVzdCBmaWxlHJ==..."
      },
      "PaymentMethod": "ach",
      "CardToken": "<string>",
      "PaymentData": {
        "MaskedAccount": "4XXXXXXXX1111",
        "AccountType": "visa",
        "AccountExp": "11/29",
        "AccountZip": "90210",
        "HolderName": "Chad Mercia",
        "orderDescription": "Depost for materials for 123 Walnut St",
        "StoredId": "1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440",
        "accountId": "<string>",
        "cloudSignatureData": "<string>",
        "cloudSignatureFormat": "<string>",
        "paymentDetails": {
          "totalAmount": 100,
          "serviceFee": 0,
          "currency": "USD",
          "checkNumber": "107",
          "checkImage": {},
          "categories": [
            {
              "label": "Deposit",
              "description": "Deposit for materials",
              "amount": 1000,
              "qty": 1
            }
          ],
          "splitFunding": [
            {
              "recipientEntryPoint": "41035afaa7",
              "accountId": "187-782",
              "description": "Split for annual dues",
              "amount": 456.23
            }
          ]
        },
        "payorData": "<string>",
        "bankAccount": "<string>"
      },
      "Bills": [
        {
          "invoiceNumber": "INV-2345",
          "netAmount": 3762.87,
          "invoiceDate": "2024-07-01",
          "dueDate": "2024-07-01",
          "comments": "Deposit for materials",
          "AccountingField1": "MyInternalId",
          "AccountingField2": "MyInternalId",
          "AdditionalData": {
            "key1": "value1",
            "key2": "value2",
            "key3": "value3"
          },
          "Terms": "NET30",
          "billId": 123,
          "attachments": [
            {
              "ftype": "pdf",
              "filename": "my-doc.pdf",
              "furl": "https://mysite.com/my-doc.pdf",
              "fContent": "TXkgdGVzdCBmaWxlHJ==..."
            }
          ]
        }
      ],
      "Events": [
        {
          "TransEvent": "Approved",
          "EventData": {},
          "EventTime": "2023-11-07T05:31:56Z"
        }
      ],
      "LastUpdated": "2022-07-01 15:00:01",
      "externalPaypointID": "Paypoint-100",
      "EntryName": "d193cf9a46",
      "Gateway": "TSYS"
    }
  ]
}

You must remove parameters= from the request before you send it, otherwise Payabli will ignore the filters.

Because of a technical limitation, you can’t make a request that includes filters from the API console on this page. The response won’t be filtered. Instead, copy the request, remove parameters= and run the request in a different client.

For example:

—url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20

should become:

—url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20

Authorizations

requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

orgId
integer
required

The numeric identifier for organization, assigned by Payabli.

Example:

123

Query Parameters

parameters
object

Collection of field names, conditions, and values used to filter the query.

List of field names accepted:

  • status (in, nin, eq, ne)
  • transactionDate (gt, ge, lt, le, eq, ne)
  • billNumber (ct, nct)
  • vendorNumber (ct, nct, eq, ne)
  • vendorName (ct, nct, eq, ne)
  • parentOrgId (ne, eq, nin, in)
  • paymentMethod (ct, nct, eq, ne, in, nin)
  • paymentId (ct, nct, eq, ne)
  • batchNumber (ct, nct, eq, ne)
  • totalAmount (gt, ge, lt, le, eq, ne)
  • paypointLegal (ne, eq, ct, nct)
  • paypointDba (ne, eq, ct, nct)
  • accountId (ne, eq, ct, nct)
  • orgName (ne, eq, ct, nct)
  • externalPaypointID (ct, nct, eq, ne)
  • paypointId (eq, ne)
  • vendorId (eq, ne)
  • vendorEIN (ct, nct, eq, ne)
  • vendorPhone (ct, nct, eq, ne)
  • vendorEmail (ct, nct, eq, ne)
  • vendorAddress (ct, nct, eq, ne)
  • vendorCity (ct, nct, eq, ne)
  • vendorState (ct, nct, eq, ne)
  • vendorCountry (ct, nct, eq, ne)
  • vendorZip (ct, nct, eq, ne)
  • vendorMCC (ct, nct, eq, ne)
  • vendorLocationCode (ct, nct, eq, ne)
  • vendorCustomField1 (ct, nct, eq, ne)
  • vendorCustomField2 (ct, nct, eq, ne)
  • comments (ct, nct)
  • payaccountCurrency (ne, eq, in, nin)
  • remitAddress (ct, nct)
  • source (ct, nct, eq, ne)
  • updatedOn (gt, ge, lt, le, eq, ne)
  • feeAmount (gt, ge, lt, le, eq, ne)
  • lotNumber (ct, nct)
  • customerVendorAccount (ct, nct, eq, ne)
  • batchId (eq, ne)

List of comparison accepted - enclosed between parentheses:

  • eq or empty => equal
  • gt => greater than
  • ge => greater or equal
  • lt => less than
  • le => less or equal
  • ne => not equal
  • ct => contains
  • nct => not contains
  • in => inside array separated by "|"
  • nin => not inside array separated by "|"

List of parameters accepted:

  • limitRecord : max number of records for query (default="20", "0" or negative value for all)
  • fromRecord : initial record in query
  • sortBy : indicate field name and direction to sort the results

Example: netAmount(gt)=20 returns all records with netAmount greater than 20.00

Example: sortBy=desc(netamount) returns all records sorted by netAmount descending

limitRecord
integer
default:20

Max number of records to return for the query. Use 0 or negative value to return all records.

Example:

0

fromRecord
integer
default:0

The number of records to skip before starting to collect the result set.

Example:

251

sortBy
string

The field name to use for sorting results. Use desc(field_name) to sort descending by field_name, and use asc(field_name) to sort ascending by field_name.

Example:

"desc(field_name)"

Response

200 - application/json
Success
Summary
object
Records
object[]