Bill

Add bill

Creates a bill in an entrypoint.

post/Bill/single/{entry}

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/Bill/single/{entry}
  • Auth: HTTP bearer

Path parameters

entrystring required

The paypoint's entrypoint identifier. Learn more

Headers

idempotencyKeystring

Optional but recommended. A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli; you must generate it yourself. The key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.

Optional but recommended A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.

Request body

accountingField1string

Optional custom field.

accountingField2string

Optional custom field.

additionalDataAdditionalDataMap

Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. If you are using custom identifiers, pass those in this object. Max length for a value is 100 characters.

{
  "additionalData": {
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
  }
}
billDatestring date

Date of bill. Send the date in YYYY-MM-DD format. The API also accepts ISO 8601 date-time values but keeps only the date.

billNumberstring

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

commentsstring

Any comment or description.

discountnumber double

Discount amount applied to the bill.

dueDatestring date

Due date of bill. Send the date in YYYY-MM-DD format. The API also accepts ISO 8601 date-time values but keeps only the date.

endDatestring date

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

frequency'onetime' | 'weekly' | 'every2weeks' | 'every6months' | 'monthly' | 'every3months' | 'annually' | 'firstofmonth' | 'fifteenthofmonth' | 'endofmonth'

Frequency for operation. The firstofmonth, fifteenthofmonth, and endofmonth values are only valid on subscriptions — they aren't accepted by other endpoints (such as invoice scheduling) that use this enum.

lotNumberstring

Lot number associated with the bill.

modeinteger

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

netAmountnumber double

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

statusinteger

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
  • 75: Partially paid
  • 100: Paid
terms'PIA' | 'CIA' | 'UR' | 'NET10' | 'NET20' | 'NET30' | 'NET45' | 'NET60' | 'NET90' | 'EOM' | 'MFI' | '5MFI' | '10MFI' | '15MFI' | '20MFI' | '2/10NET30' | 'UF' | '10UF' | '20UF' | '25UF' | '50UF'

Payment terms for invoice. If no terms are defined, then response data for this field defaults to NET30.

totalAmountnumber double

Total amount of the bill.

Response

Success

responseCodeinteger

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

pageIdentifierstring

Auxiliary validation used internally by payment pages and components.

roomIdinteger

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.

responseTextstring required

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

Changes

No recorded changes to this operation across all 1 revision of this API.