GET
/
Bill
/
{idBill}
curl --request GET \
  --url https://api-sandbox.payabli.com/api/Bill/{idBill} \
  --header 'requestToken: <api-key>'
{
  "isSuccess": true,
  "responseText": "Success",
  "responseData": {
    "billNumber": "ABC-123",
    "netAmount": 3762.87,
    "billDate": "2024-07-01",
    "dueDate": "2024-07-01",
    "comments": "Deposit for materials",
    "billItems": [
      {
        "itemProductCode": "M-DEPOSIT",
        "itemProductName": "Materials deposit",
        "itemDescription": "Deposit for materials.",
        "itemCommodityCode": "010",
        "itemUnitOfMeasure": "SqFt",
        "itemCost": 5,
        "itemQty": 1,
        "itemMode": 0,
        "itemCategories": [
          null
        ],
        "itemTotalAmount": 123,
        "itemTaxAmount": 7,
        "itemTaxRate": 0.075
      }
    ],
    "mode": 0,
    "accountingField1": "MyInternalId",
    "accountingField2": "MyInternalId",
    "AdditionalData": {
      "key1": "value1",
      "key2": "value2",
      "key3": "value3"
    },
    "vendor": {
      "vendorNumber": "1234",
      "name1": "Herman's Coatings and Masonry",
      "name2": null,
      "ein": "XXXX6789",
      "phone": "5555555555",
      "email": "contact@hermanscoatings.com",
      "address1": "123 Ocean Drive",
      "address2": "Suite 400",
      "city": "Miami",
      "state": "FL",
      "zip": "33139",
      "country": "US",
      "mcc": "7777",
      "locationCode": "MIA123",
      "contacts": [
        {
          "contactName": "Herman Martinez",
          "contactEmail": "herman@hermanscoatings.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": "vcard",
      "vendorStatus": 1,
      "remitAddress1": "123 Walnut Street",
      "remitAddress2": "Suite 900",
      "remitCity": "Miami",
      "remitState": "FL",
      "remitZip": "31113",
      "remitCountry": "US",
      "payeeName1": null,
      "payeeName2": null,
      "customerVendorAccount": "A-37622",
      "internalReferenceId": 123,
      "vendorId": "1340",
      "AdditionalData": {
        "key1": "value1",
        "key2": "value2",
        "key3": "value3"
      }
    },
    "endDate": "2024-07-01",
    "frequency": "monthly",
    "terms": "NET30",
    "status": -99,
    "Transaction": {
      "IdOut": 236,
      "Vendor": {
        "vendorNumber": "1234",
        "name1": "Herman's Coatings",
        "name2": "Herman's Coating Supply Company, LLC",
        "ein": "123456789",
        "phone": "212-555-1234",
        "email": "example@example.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": "herman@hermanscoatings.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": null,
        "payeeName2": null,
        "customerVendorAccount": "123-456",
        "internalReferenceId": 123,
        "additionalData": {
          "key1": "value1",
          "key2": "value2",
          "key3": "value3"
        },
        "externalPaypointId": "Paypoint-100"
      },
      "Comments": "Deposit for materials",
      "parentOrgName": "PropertyManager Pro",
      "paypointDbaname": "Sunshine Gutters",
      "paypointLegalname": "Sunshine Services, LLC",
      "TotalAmount": 110.25,
      "NetAmount": 100,
      "FeeAmount": 10.25,
      "Source": "api",
      "PaymentId": "2345667-ddd-fff",
      "PaymentGroup": "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",
      "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",
        "Initiator": "payor",
        "StoredMethodUsageType": "subscription",
        "Sequence": "subsequent",
        "accountId": null,
        "SignatureData": null,
        "binData": {
          "binMatchedLength": 6,
          "binCardBrand": "Visa",
          "binCardType": "Credit",
          "binCardCategory": "PLATINUM",
          "binCardIssuer": "Bank of Example",
          "binCardIssuerCountry": "United States",
          "binCardIssuerCountryCodeA2": "US",
          "binCardIssuerCountryNumber": 840
        },
        "paymentDetails": {
          "totalAmount": 100,
          "serviceFee": 0,
          "currency": "USD",
          "checkNumber": "107",
          "checkImage": {},
          "categories": [
            {
              "label": "Deposit",
              "description": "Deposit for materials",
              "amount": 1000,
              "qty": 123
            }
          ],
          "splitFunding": [
            {
              "recipientEntryPoint": "41035afaa7",
              "accountId": "187-782",
              "description": "Split for annual dues",
              "amount": 456.23
            }
          ]
        }
      },
      "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"
        }
      ],
      "CreatedDate": "2022-07-01 15:00:01",
      "LastUpdated": "2022-07-01 15:00:01"
    }
  }
}

Authorizations

​
requestToken
string
header
required

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

Path Parameters

​
idBill
integer
required

Payabli ID for the bill. Get this ID by querying /api/Query/bills/ for the entrypoint or the organization.

Example:

285

Response

200
application/json

Success

The response is of type object.