Add Bill
Creates a bill in an entrypoint.
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.
"6B29FC40-CA47-1067-B31D-00DD010662DA"
Path Parameters
The paypoint's entrypoint identifier. Learn more
"8cfec329267"
Body
Unique identifier for the bill. Required when adding a bill.
"ABC-123"
Net Amount owed in bill. Required when adding a bill.
3762.87
Date of bill. Accepted formats: YYYY-MM-DD, MM/DD/YYYY.
"2024-07-01"
Due date of bill. Accepted formats: YYYY-MM-DD, MM/DD/YYYY.
"2024-07-01"
Any comment or description.
250
"Deposit for materials"
Array of LineItems
contained in bill.
Bill mode: value 0
for one-time bills, 1
for scheduled bills.
0
, 1
Optional custom field.
"MyInternalId"
Optional custom field.
"MyInternalId"
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"
}
}
{
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
End Date for scheduled bills. Applied only in Mode
= 1. Accepted formats: YYYY-MM-DD, MM/DD/YYYY
"2024-07-01"
Frequency for scheduled bills. Applied only in Mode
= 1.
one-time
, weekly
, every2weeks
, every6months
, monthly
, every3months
, annually
"monthly"
Description of payment terms.
"NET30"
The bill's status. Values are:
-99
: deleted or canceled1
: Active2
: Sent to approval5
: Partially approved11
: Rejected20
: Approved50
: Payment in transit100
: Paid "
-99
, 1
, 2
, 5
, 11
, 20
, 50
, 100
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
Boolean indicating whether the operation was successful. A true
value indicates success. A false
value indicates failure.
true
Response text for operation: 'Success' or 'Declined'.
"Success"
Code for the response. Learn more in API Response Codes.
1
If isSuccess
= true, this contains the bill identifier. If isSuccess
= false, this contains the reason for the error.
Auxiliary validation used internally by payment pages and components.
null
Was this page helpful?