Payabli Docs

curl https://api-sandbox.payabli.com/api/Bill/285 \
     -H "requestToken: <apiKey>"

{
  "responseText": "Success",
  "responseCode": 1,
  "roomId": 0,
  "isSuccess": true,
  "responseData": {
    "BillDate": "2025-07-01",
    "DueDate": "2025-07-01",
    "IdBill": 285,
    "BillNumber": "ABC-123",
    "NetAmount": 100,
    "TotalAmount": 100,
    "Comments": "Deposit for materials",
    "BillItems": [
      {
        "itemCost": 5,
        "itemCommodityCode": "010",
        "itemDescription": "Deposit for materials.",
        "itemMode": 0,
        "itemProductCode": "M-DEPOSIT",
        "itemProductName": "Materials deposit",
        "itemQty": 1,
        "itemTaxAmount": 7,
        "itemTaxRate": 0.075,
        "itemTotalAmount": 123,
        "itemUnitOfMeasure": "SqFt"
      }
    ],
    "Mode": 0,
    "AccountingField1": "MyInternalId",
    "AccountingField2": "MyInternalId",
    "Vendor": {
      "VendorNumber": "1234",
      "Name1": "Herman's Coatings and Masonry",
      "Name2": "",
      "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": [
        {
          "ContactEmail": "herman@hermanscoatings.com",
          "ContactName": "Herman Martinez",
          "ContactPhone": "3055550000",
          "ContactTitle": "Owner"
        }
      ],
      "BillingData": {
        "id": 123,
        "accountId": "acct-1xxxxx3123",
        "nickname": "Checking Account",
        "bankName": "Country Bank",
        "routingAccount": "123123123",
        "accountNumber": "1XXXXXX3123",
        "typeAccount": "Checking",
        "bankAccountHolderName": "Gruzya Adventure Outfitters LLC",
        "bankAccountHolderType": "Business",
        "bankAccountFunction": 0,
        "verified": true,
        "status": 1,
        "services": [],
        "default": true
      },
      "PaymentMethod": "vcard",
      "VendorStatus": 1,
      "VendorId": 1234,
      "Summary": {
        "ActiveBills": 5,
        "PendingBills": 2,
        "InTransitBills": 1,
        "PaidBills": 10,
        "OverdueBills": 0,
        "ApprovedBills": 3,
        "DisapprovedBills": 0,
        "TotalBills": 21,
        "ActiveBillsAmount": 1500,
        "PendingBillsAmount": 500,
        "InTransitBillsAmount": 200,
        "PaidBillsAmount": 3000,
        "OverdueBillsAmount": 0,
        "ApprovedBillsAmount": 800,
        "DisapprovedBillsAmount": 0,
        "TotalBillsAmount": 6000
      },
      "PaypointLegalname": "Gruzya Adventure Outfitters LLC",
      "PaypointDbaname": "Gruzya Adventure Outfitters",
      "PaypointEntryname": "41035afaa7",
      "ParentOrgName": "Pilgrim Planner",
      "ParentOrgId": 1232,
      "CreatedDate": "2022-07-01T15:00:01Z",
      "LastUpdated": "2022-07-01T15:00:01Z",
      "remitAddress1": "123 Walnut Street",
      "remitAddress2": "Suite 900",
      "remitCity": "Miami",
      "remitState": "FL",
      "remitZip": "31113",
      "remitCountry": "US",
      "payeeName1": "Herman Martinez",
      "payeeName2": "",
      "customField1": "",
      "customField2": "",
      "InternalReferenceId": 123,
      "additionalData": {
        "customField": "Custom Value 1",
        "reference": "REF-12345",
        "notes": "Additional vendor information"
      },
      "externalPaypointID": "ext123",
      "StoredMethods": [],
      "customerVendorAccount": "A-37622"
    },
    "Status": -99,
    "CreatedAt": "2025-07-01T15:00:01Z",
    "LastUpdated": "2025-07-01T15:00:01Z",
    "billEvents": [
      {
        "description": "Created Bill",
        "eventTime": "2025-07-01T15:00:01Z",
        "refData": "REF-12345",
        "source": "API"
      }
    ],
    "PaypointLegalname": "Gruzya Adventure Outfitters LLC",
    "PaypointDbaname": "Gruzya Adventure Outfitters",
    "ParentOrgId": 1232,
    "ParentOrgName": "Pilgrim Planner",
    "PaypointEntryname": "41035afaa7",
    "DocumentsRef": {
      "filelist": [
        {
          "originalName": "invoice.pdf",
          "zipName": "0_invoice.pdf",
          "descriptor": "Invoice document"
        }
      ],
      "zipfile": "documents_285.zip"
    },
    "LotNumber": "LOT-285"
  }
}

Retrieves a bill by ID from an entrypoint.

Authentication

requestTokenstring

API Key authentication via header

Path parameters

idBillintegerRequired

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

Response

Success

responseTextstring

Response text for operation: ‘Success’ or ‘Declined’.

responseCodeinteger

Code for the response. Learn more in API Response Codes.

pageIdentifierstring

Auxiliary validation used internally by payment pages and components.

roomIdlong

Field not in use on this endpoint. It always returns 0.

isSuccessboolean

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

responseDataobject

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error