BillOutData Object Model

accountingField1

string | null

Optional custom field.

accountingField2

string | null

Optional custom field.

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"
  }
}

attachments

object[] | null

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

billDate

string | null

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

billItems

object[] | null

Array of LineItems contained in bill.

billNumber

string | null

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

comments

string | null

Any comment or description.

Maximum length: 250

dueDate

string | null

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

endDate

string | null

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

frequency

enum<string> | null

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

Available options:

one-time,

weekly,

every2weeks,

every6months,

monthly,

every3months,

annually

mode

enum<integer> | null

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

Available options:

0,

1

netAmount

string | null

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

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

terms

string | null

Description of payment terms.

vendor

object

vendor.AdditionalData

object

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"
  }
}

vendor.address1

string | null

Vendor's address

vendor.address2

string | null

Additional line for vendor's address.

vendor.billingData

object

Object containing vendor's bank information.

vendor.city

string

Vendor's city.

vendor.contacts

object[] | null

Array of objects describing the vendor's contacts.

vendor.country

string

Vendor's country.

vendor.customerVendorAccount

string | null

Account number of paypoint in the vendor side.

vendor.ein

string

EIN/Tax ID for vendor.

vendor.email

string | null

Vendor's email address. Required for vCard.

vendor.internalReferenceId

integer | null

Internal identifier for global vendor account.

vendor.locationCode

string | null

Additional location code used to identify the vendor.

vendor.mcc

string | null

Business Merchant Category Code (MCC). This resource lists MCC codes.

vendor.name1

string

Primary name for vendor. Required for new vendor.

vendor.name2

string | null

Secondary name for vendor.

vendor.payeeName1

string | null

Alternative name used to receive paper check.

vendor.payeeName2

string | null

Alternative name used to receive paper check.

vendor.paymentMethod

object

Object containing details about the payment method to use for the payout.

vendor.phone

string | null

Vendor's phone number. Phone number can't contain non-digit characters like hyphens or parentheses.

vendor.remitAddress1

string | null

Remittance address. Used for mailing paper checks.

vendor.remitAddress2

string | null

Remittance address additional line. Used for mailing paper checks.

vendor.remitCity

string | null

Remittance address city. Used for mailing paper checks.

vendor.remitCountry

string | null

Remittance address country. Used for mailing paper checks.

vendor.remitState

string | null

Remittance address state. Used for mailing paper checks.

vendor.remitZip

string | null

Remittance address ZIP code. Used for mailing paper checks.

vendor.state

string

Vendor's state. Must be a 2 character state code.

vendor.vendorNumber

string | null

Custom number identifying the vendor. Must be unique in paypoint.

vendor.vendorStatus

integer | null

Vendor's status. Allowed status:

0 Inactive
1 Active

vendor.zip

string

Vendor's zip code.

API Basics

Pay In Endpoints

Pay Out Endpoints

Pay Ops Endpoints

Object Models

BillOutData Object Model