API Basics
Pay In Endpoints
- MoneyIn
- Subscription
- TokenStorage
- Invoice
- LineItem
- PaymentLink
- PaymentMethodDomain
- HostedPaymentPages
- Cloud
- Wallet: Apple Pay
Pay Out Endpoints
Pay Ops Endpoints
- Templates
- Boarding
- Chargebacks and ACH Returns
- Entities
- Notification
- Query
- Statistic
- Export
- Import
Object Models
- Object Model References
Add Bill
Creates a bill in an entrypoint.
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
Most endpoints require an organization
token. Some endpoints require an application
token, and those endpoints are noted.
Headers
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
The paypoint's entrypoint identifier. Learn more
Example:
"8cfec329267"
Body
BillOutData object to add.
The body is of type object
.
Response
200
application/json
Success
The response is of type object
.
Was this page helpful?
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
}