POST
/
Bill
/
single
/
{entry}
curl --request POST \
  --url https://api-sandbox.payabli.com/api/Bill/single/{entry} \
  --header 'Content-Type: application/json' \
  --header 'requestToken: <api-key>' \
  --data '{
  "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": [
        "<string>"
      ],
      "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": "<string>",
    "ein": "12-3456789",
    "phone": "5555555555",
    "email": "example@email.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": "example@email.com",
        "contactTitle": "Owner",
        "contactPhone": "3055550000"
      }
    ],
    "billingData": {
      "id": 123,
      "bankName": "Country Bank",
      "routingAccount": "123123123",
      "accountNumber": "123123123",
      "typeAccount": "Checking",
      "bankAccountHolderName": "Gruzya Adventure Outfitters LLC",
      "bankAccountHolderType": "Business",
      "bankAccountFunction": 0
    },
    "paymentMethod": {
      "method": "managed"
    },
    "vendorStatus": 1,
    "remitAddress1": "123 Walnut Street",
    "remitAddress2": "Suite 900",
    "remitCity": "Miami",
    "remitState": "FL",
    "remitZip": "31113",
    "remitCountry": "US",
    "payeeName1": "<string>",
    "payeeName2": "<string>",
    "customerVendorAccount": "A-37622",
    "internalReferenceId": 123,
    "AdditionalData": {
      "key1": "value1",
      "key2": "value2",
      "key3": "value3"
    }
  },
  "endDate": "2024-07-01",
  "frequency": "monthly",
  "terms": "NET30",
  "status": -99,
  "attachments": [
    {
      "ftype": "pdf",
      "filename": "my-doc.pdf",
      "furl": "https://mysite.com/my-doc.pdf",
      "fContent": "TXkgdGVzdCBmaWxlHJ==..."
    }
  ]
}'
{
  "isSuccess": true,
  "responseText": "Success",
  "responseCode": 1,
  "responseData": 6101,
  "pageidentifier": null
}

Authorizations

requestToken
string
header
required

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

Headers

idempotencyKey
string

A unique ID you can include to prevent duplicating objects or transactions if a request is sent more than once. This key is not generated in Payabli, you must generate it yourself.

Example:

"6B29FC40-CA47-1067-B31D-00DD010662DA"

Path Parameters

entry
string
required

The paypoint's entrypoint identifier. Learn more

Example:

"8cfec329267"

Body

BillOutData object to add.
billNumber
string | null

Unique identifier for the bill. Required when adding a bill.

Example:

"ABC-123"

netAmount
string | null

Net Amount owed in bill. Required when adding a bill.

Example:

3762.87

billDate
string | null

Date of bill. Accepted formats: YYYY-MM-DD, MM/DD/YYYY.

Example:

"2024-07-01"

dueDate
string | null

Due date of bill. Accepted formats: YYYY-MM-DD, MM/DD/YYYY.

Example:

"2024-07-01"

comments
string | null

Any comment or description.

Maximum length: 250
Example:

"Deposit for materials"

billItems
object[] | null

Array of LineItems contained in bill.

mode
enum<integer> | null

Bill mode: value 0 for one-time bills, 1 for scheduled bills.

Available options:
0,
1
accountingField1
string | null

Optional custom field.

Example:

"MyInternalId"

accountingField2
string | null

Optional custom field.

Example:

"MyInternalId"

AdditionalData
string | null

Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. Example usage:

{
  "additionalData": {
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
  }
}
Example:
{
  "key1": "value1",
  "key2": "value2",
  "key3": "value3"
}
vendor
object
endDate
string | null

End Date for scheduled bills. Applied only in Mode = 1. Accepted formats: YYYY-MM-DD, MM/DD/YYYY

Example:

"2024-07-01"

frequency
enum<string> | null

Frequency for scheduled bills. Applied only in Mode = 1.

Available options:
one-time,
weekly,
every2weeks,
every6months,
monthly,
every3months,
annually
Example:

"monthly"

terms
string | null

Description of payment terms.

Example:

"NET30"

status
enum<integer>

The bill's status. Values are:

  • -99: deleted or canceled
  • 1: Active
  • 2: Sent to approval
  • 5: Partially approved
  • 11: Rejected
  • 20: Approved
  • 50: Payment in transit
  • 100: Paid "
Available options:
-99,
1,
2,
5,
11,
20,
50,
100
attachments
object[] | null

Array of fileContent objects with attached documents. Max upload size is 30 MB.

Contains details about a file. See See fileObject Object Model for a complete reference. Max upload size is 30 MB.

Response

200
application/json
Success
isSuccess
boolean

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

Example:

true

responseText
string | null

Response text for operation: 'Success' or 'Declined'.

Example:

"Success"

responseCode
integer | null

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

Example:

1

responseData

If isSuccess = true, this contains the bill identifier. If isSuccess = false, this contains the reason for the error.

pageidentifier
string | null

Auxiliary validation used internally by payment pages and components.

Example:

null

Was this page helpful?