# List bills by paypoint
GET https://api-sandbox.payabli.com/api/Query/bills/{entry}
Retrieve a list of bills for an entrypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
Reference: https://docs.payabli.com/developers/api-reference/bill/get-list-of-bills-for-entrypoint
## OpenAPI Specification
```yaml
openapi: 3.1.1
info:
title: Get list of bills for entrypoint
version: endpoint_bill.ListBills
paths:
/Query/bills/{entry}:
get:
operationId: list-bills
summary: Get list of bills for entrypoint
description: >-
Retrieve a list of bills for an entrypoint. Use filters to limit
results. Include the `exportFormat` query parameter to return the
results as a file instead of a JSON response.
tags:
- - subpackage_bill
parameters:
- name: entry
in: path
description: >-
The paypoint's entrypoint identifier. [Learn
more](/developers/api-reference/api-overview#entrypoint-vs-entry)
required: true
schema:
type: string
- name: exportFormat
in: query
required: false
schema:
$ref: '#/components/schemas/type_:ExportFormat'
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
default: 0
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
default: 20
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response isn't filtered. Instead, copy the request, remove `parameters=` and run the request in a different client.
For example:
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
should become:
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
List of field names accepted:
- `frequency` (`in`, `nin`, `ne`, `eq`)
- `method` (`in`, `nin`, `eq`, `ne`)
- `event` (`in`, `nin`, `eq`, `ne`)
- `target` (`ct`, `nct`, `eq`, `ne`)
- `status` (`eq`, `ne`)
- `approvalUserId` (`eq`, `ne`)
- `parentOrgId` (`ne`, `eq`, `nin`, `in`)
- `approvalUserEmail` (`eq`, `ne`)
- `scheduleId` (`ne`, `eq`)
List of comparison accepted - enclosed between parentheses:
- `eq` or empty => equal
- `gt` => greater than
- `ge` => greater or equal
- `lt` => less than
- `le` => less or equal
- `ne` => not equal
- `ct` => contains
- `nct` => not contains
- `in` => inside array
- `nin` => not inside array
List of parameters accepted:
- `limitRecord` : max number of records for query (default="20", "0"
or negative value for all)
- `fromRecord` : initial record in query
Example: `totalAmount(gt)=20` returns all records with a
`totalAmount` that's greater than 20.00
required: false
schema:
type: object
additionalProperties:
type: string
- name: sortBy
in: query
description: >-
The field name to use for sorting results. Use `desc(field_name)` to
sort descending by `field_name`, and use `asc(field_name)` to sort
ascending by `field_name`.
required: false
schema:
type: string
- name: requestToken
in: header
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/type_:BillQueryResponse'
'400':
description: Bad request/ invalid data
content: {}
'401':
description: Unauthorized request.
content: {}
'500':
description: Internal API Error
content: {}
'503':
description: Database connection error
content: {}
components:
schemas:
type_:ExportFormat:
type: string
enum:
- description: Comma-separated values file
value: csv
- description: Excel spreadsheet file
value: xlsx
type_:PageIdentifier:
type: string
type_:Pagesize:
type: integer
type_:Totalpages:
type: integer
type_:Totalrecords:
type: integer
type_:BillQueryResponseSummary:
type: object
properties:
pageidentifier:
$ref: '#/components/schemas/type_:PageIdentifier'
pageSize:
$ref: '#/components/schemas/type_:Pagesize'
total2approval:
type: integer
totalactive:
type: integer
totalAmount:
type: number
format: double
description: Total amount of bills in response.
totalamount2approval:
type: number
format: double
totalamountactive:
type: number
format: double
totalamountapproved:
type: number
format: double
description: The total amount of approved bills.
totalamountcancel:
type: number
format: double
totalamountdisapproved:
type: number
format: double
description: The total amount of disapproved bills.
totalamountintransit:
type: number
format: double
totalamountoverdue:
type: number
format: double
description: The total amount of bills that are overdue.
totalamountpaid:
type: number
format: double
description: The total amount of paid bills.
totalamountsent2approval:
type: number
format: double
totalapproved:
type: integer
description: The total number of bills that were approved.
totalcancel:
type: integer
totaldisapproved:
type: integer
description: The number of bills that were disapproved.
totalintransit:
type: integer
totaloverdue:
type: integer
description: The number of bills that are overdue.
totalPages:
$ref: '#/components/schemas/type_:Totalpages'
totalpaid:
type: integer
description: The total number of paid bills.
totalRecords:
$ref: '#/components/schemas/type_:Totalrecords'
totalsent2approval:
type: integer
type_:AccountingField:
type: string
type_:DatetimeNullable:
type: string
format: date-time
type_:Email:
type: string
format: email
type_:BillQueryRecord2BillApprovalsItem:
type: object
properties:
approved:
type: integer
description: >-
Indicates whether the bill has been approved. `0` is false, and `1`
is true.
approvedTime:
$ref: '#/components/schemas/type_:DatetimeNullable'
description: Timestamp of when the approval was made, in UTC.
comments:
type: string
description: Additional comments on the approval.
email:
$ref: '#/components/schemas/type_:Email'
description: The approving user's email address.
Id:
type: integer
format: int64
description: The approving user's ID.
type_:Datenullable:
type: string
format: date
type_:Source:
type: string
type_:GeneralEvents:
type: object
properties:
description:
type: string
description: Event description.
eventTime:
type: string
format: date-time
description: Event timestamp, in UTC.
extraData:
type: object
additionalProperties:
description: Any type
description: Extra data.
refData:
type: string
description: Reference data.
source:
$ref: '#/components/schemas/type_:Source'
description: The event source.
type_:ItemCommodityCode:
type: string
type_:ItemDescription:
type: string
type_:ItemProductCode:
type: string
type_:ItemProductName:
type: string
type_:ItemUnitofMeasure:
type: string
type_:BillItem:
type: object
properties:
itemCategories:
type: array
items:
type: string
description: Array of tags classifying item or product.
itemCommodityCode:
$ref: '#/components/schemas/type_:ItemCommodityCode'
itemCost:
type: number
format: double
description: Item or product price per unit.
itemDescription:
$ref: '#/components/schemas/type_:ItemDescription'
itemMode:
type: integer
description: >-
Internal class of item or product: value '0' is only for invoices ,
'1' for bills and, '2' common for both.
itemProductCode:
$ref: '#/components/schemas/type_:ItemProductCode'
itemProductName:
$ref: '#/components/schemas/type_:ItemProductName'
itemQty:
type: integer
description: Quantity of item or product.
itemTaxAmount:
type: number
format: double
description: Tax amount applied to item or product.
itemTaxRate:
type: number
format: double
description: Tax rate applied to item or product.
itemTotalAmount:
type: number
format: double
description: Total amount in item or product.
itemUnitOfMeasure:
$ref: '#/components/schemas/type_:ItemUnitofMeasure'
required:
- itemCost
type_:CreatedAt:
type: string
format: date-time
type_:ExternalPaypointId:
type: string
type_:Frequency:
type: string
enum:
- value: onetime
- value: weekly
- value: every2weeks
- value: every6months
- value: monthly
- value: every3months
- value: annually
type_:OrgParentName:
type: string
type_:PaymentIdString:
type: string
type_:BillQueryRecord2PaymentMethod:
type: string
enum:
- value: vcard
- value: ach
- value: check
- value: card
- value: managed
type_:Dbaname:
type: string
type_:Legalname:
type: string
type_:Billstatus:
type: integer
type_:Terms:
type: string
type_:Comments:
type: string
type_:AdditionalData:
type: object
additionalProperties:
type: object
additionalProperties:
description: Any type
type_:AddressNullable:
type: string
type_:AddressAddtlNullable:
type: string
type_:BankName:
type: string
type_:RoutingAccount:
type: string
type_:AccountNumber:
type: string
type_:TypeAccount:
type: string
enum:
- value: Checking
- value: Savings
type_:BankAccountHolderName:
type: string
type_:BankAccountHolderType:
type: string
enum:
- value: Personal
- value: Business
type_:BillingDataResponse:
type: object
properties:
id:
type: integer
description: The bank's ID in Payabli.
accountId:
description: Any type
nickname:
type: string
bankName:
$ref: '#/components/schemas/type_:BankName'
routingAccount:
$ref: '#/components/schemas/type_:RoutingAccount'
accountNumber:
$ref: '#/components/schemas/type_:AccountNumber'
typeAccount:
$ref: '#/components/schemas/type_:TypeAccount'
bankAccountHolderName:
$ref: '#/components/schemas/type_:BankAccountHolderName'
bankAccountHolderType:
$ref: '#/components/schemas/type_:BankAccountHolderType'
bankAccountFunction:
type: integer
description: >-
Describes whether the bank account is used for deposits or
withdrawals in Payabli:
- `0`: Deposit
- `1`: Withdrawal
- `2`: Deposit and withdrawal
verified:
type: boolean
status:
type: integer
services:
type: array
items:
description: Any type
default:
type: boolean
required:
- id
- nickname
- bankName
- routingAccount
- accountNumber
- typeAccount
- bankAccountHolderName
- bankAccountHolderType
- bankAccountFunction
- verified
- status
- services
- default
type_:CityNullable:
type: string
type_:ContactsResponse:
type: object
properties:
ContactEmail:
$ref: '#/components/schemas/type_:Email'
description: Contact email address.
ContactName:
type: string
description: Contact name.
ContactPhone:
type: string
description: Contact phone number.
ContactTitle:
type: string
description: Contact title.
type_:Ein:
type: string
type_:EnrollmentStatus:
type: string
type_:InternalReferenceId:
type: integer
format: int64
type_:LastModified:
type: string
format: date-time
type_:Mcc:
type: string
type_:OrgParentId:
type: integer
format: int64
type_:PayeeName:
type: string
type_:VendorPaymentMethodString:
type: string
type_:Entrypointfield:
type: string
type_:Remitaddress1:
type: string
type_:Remitaddress2:
type: string
type_:Remitcity:
type: string
type_:Remitcountry:
type: string
type_:RemitEmail:
type: string
format: email
type_:Remitstate:
type: string
type_:Remitzip:
type: string
type_:StateNullable:
type: string
type_:VendorResponseStoredMethod:
type: object
properties:
IdPmethod:
type:
- string
- 'null'
Method:
type:
- string
- 'null'
Descriptor:
type:
- string
- 'null'
MaskedAccount:
type:
- string
- 'null'
ExpDate:
type:
- string
- 'null'
HolderName:
type:
- string
- 'null'
AchSecCode:
type:
- string
- 'null'
AchHolderType:
type:
- string
- 'null'
IsValidatedACH:
type:
- boolean
- 'null'
BIN:
type:
- string
- 'null'
binData:
type:
- string
- 'null'
ABA:
type:
- string
- 'null'
PostalCode:
type:
- string
- 'null'
MethodType:
type:
- string
- 'null'
LastUpdated:
type:
- string
- 'null'
format: date-time
CardUpdatedOn:
type:
- string
- 'null'
format: date-time
required:
- IdPmethod
- Method
- Descriptor
- MaskedAccount
- ExpDate
- HolderName
- AchSecCode
- AchHolderType
- IsValidatedACH
- BIN
- binData
- ABA
- PostalCode
- MethodType
- LastUpdated
- CardUpdatedOn
type_:VendorSummary:
type: object
properties:
ActiveBills:
type: integer
PendingBills:
type: integer
InTransitBills:
type: integer
PaidBills:
type: integer
OverdueBills:
type: integer
ApprovedBills:
type: integer
DisapprovedBills:
type: integer
TotalBills:
type: integer
ActiveBillsAmount:
type: number
format: double
PendingBillsAmount:
type: number
format: double
InTransitBillsAmount:
type: number
format: double
PaidBillsAmount:
type: number
format: double
OverdueBillsAmount:
type: number
format: double
ApprovedBillsAmount:
type: number
format: double
DisapprovedBillsAmount:
type: number
format: double
TotalBillsAmount:
type: number
format: double
type_:Vendorid:
type: integer
type_:VendorNumber:
type: string
type_:Vendorstatus:
type: integer
type_:Zip:
type: string
type_:VendorQueryRecord:
type: object
properties:
additionalData:
$ref: '#/components/schemas/type_:AdditionalData'
Address1:
$ref: '#/components/schemas/type_:AddressNullable'
Address2:
$ref: '#/components/schemas/type_:AddressAddtlNullable'
BillingData:
$ref: '#/components/schemas/type_:BillingDataResponse'
City:
$ref: '#/components/schemas/type_:CityNullable'
Contacts:
$ref: '#/components/schemas/type_:ContactsResponse'
Country:
type: string
CreatedDate:
$ref: '#/components/schemas/type_:CreatedAt'
customerVendorAccount:
type: string
customField1:
type: string
customField2:
type: string
EIN:
$ref: '#/components/schemas/type_:Ein'
Email:
$ref: '#/components/schemas/type_:Email'
EnrollmentStatus:
$ref: '#/components/schemas/type_:EnrollmentStatus'
externalPaypointID:
$ref: '#/components/schemas/type_:ExternalPaypointId'
InternalReferenceId:
$ref: '#/components/schemas/type_:InternalReferenceId'
LastUpdated:
$ref: '#/components/schemas/type_:LastModified'
LocationCode:
type: string
Mcc:
$ref: '#/components/schemas/type_:Mcc'
Name1:
type: string
Name2:
type: string
ParentOrgName:
$ref: '#/components/schemas/type_:OrgParentName'
ParentOrgId:
$ref: '#/components/schemas/type_:OrgParentId'
payeeName1:
$ref: '#/components/schemas/type_:PayeeName'
payeeName2:
$ref: '#/components/schemas/type_:PayeeName'
PaymentMethod:
$ref: '#/components/schemas/type_:VendorPaymentMethodString'
PaypointDbaname:
$ref: '#/components/schemas/type_:Dbaname'
PaypointEntryname:
$ref: '#/components/schemas/type_:Entrypointfield'
PaypointLegalname:
$ref: '#/components/schemas/type_:Legalname'
Phone:
type: string
remitAddress1:
$ref: '#/components/schemas/type_:Remitaddress1'
remitAddress2:
$ref: '#/components/schemas/type_:Remitaddress2'
remitCity:
$ref: '#/components/schemas/type_:Remitcity'
remitCountry:
$ref: '#/components/schemas/type_:Remitcountry'
RemitEmail:
$ref: '#/components/schemas/type_:RemitEmail'
remitState:
$ref: '#/components/schemas/type_:Remitstate'
remitZip:
$ref: '#/components/schemas/type_:Remitzip'
State:
$ref: '#/components/schemas/type_:StateNullable'
StoredMethods:
type: array
items:
$ref: '#/components/schemas/type_:VendorResponseStoredMethod'
Summary:
$ref: '#/components/schemas/type_:VendorSummary'
VendorId:
$ref: '#/components/schemas/type_:Vendorid'
VendorNumber:
$ref: '#/components/schemas/type_:VendorNumber'
VendorStatus:
$ref: '#/components/schemas/type_:Vendorstatus'
Zip:
$ref: '#/components/schemas/type_:Zip'
type_:Netamountnullable:
type: number
format: double
type_:FeeAmount:
type: number
format: double
type_:Orgid:
type: integer
format: int64
type_:FileContentFtype:
type: string
enum:
- value: pdf
- value: doc
- value: docx
- value: jpg
- value: jpeg
- value: png
- value: gif
- value: txt
type_:FileContent:
type: object
properties:
fContent:
type: string
description: >-
Content of file, Base64-encoded. Ignored if furl is specified. Max
upload size is 30 MB.
filename:
type: string
description: The name of the attached file.
ftype:
$ref: '#/components/schemas/type_:FileContentFtype'
description: The MIME type of the file (if content is provided)
furl:
type: string
description: Optional URL provided to show or download the file remotely
type_:Accountexp:
type: string
type_:Accountid:
type: string
type_:Accounttype:
type: string
type_:Accountzip:
type: string
type_:BinData:
type: object
properties:
binMatchedLength:
type: string
description: |-
The number of characters from the beginning of the card number that
were matched against a Bank Identification Number (BIN) or the Card
Range table.
binCardBrand:
type: string
description: |-
The card brand. For example, Visa, Mastercard, American Express,
Discover.
binCardType:
type: string
description: 'The type of card: Credit or Debit.'
binCardCategory:
type: string
description: >-
The category of the card, which indicates the card product. For
example: Standard, Gold, Platinum, etc. The binCardCategory for
prepaid cards is marked `PREPAID`.
binCardIssuer:
type: string
description: The name of the financial institution that issued the card.
binCardIssuerCountry:
type: string
description: The issuing financial institution's country name.
binCardIssuerCountryCodeA2:
type: string
description: >-
The issuing financial institution's two-character ISO country code.
See [this resource](https://www.iso.org/obp/ui/#search) for a list
of codes.
binCardIssuerCountryNumber:
type: string
description: >-
The issuing financial institution's ISO standard numeric country
code. See [this resource](https://www.iso.org/obp/ui/#search) for a
list of codes.
binCardIsRegulated:
type: string
description: Indicates whether the card is regulated.
binCardUseCategory:
type: string
description: The use category classification for the card.
binCardIssuerCountryCodeA3:
type: string
description: >-
The issuing financial institution's three-character ISO country
code.
See [this resource](https://www.iso.org/obp/ui/#search) for a list
of
codes.
type_:Holdername:
type: string
type_:Initiator:
type: string
type_:Maskedaccount:
type: string
type_:Orderdescription:
type: string
type_:PaymentCategories:
type: object
properties:
amount:
type: number
format: double
description: Price/cost per unit of item or category.
description:
type: string
description: Description of item or category
label:
type: string
description: Name of item or category.
qty:
type: integer
default: 1
description: Quantity of item or category
required:
- amount
- label
type_:SplitFundingContent:
type: object
properties:
accountId:
type: string
description: The accountId for the account the split should be sent to.
amount:
type: number
format: double
description: Amount from the transaction to sent to this recipient.
description:
type: string
description: A description for the split.
recipientEntryPoint:
type: string
description: The entrypoint the split should be sent to.
type_:SplitFunding:
type: array
items:
$ref: '#/components/schemas/type_:SplitFundingContent'
type_:PaymentDetail:
type: object
properties:
categories:
type: array
items:
$ref: '#/components/schemas/type_:PaymentCategories'
description: >-
Array of payment categories/line items describing the amount to be
paid.
**Note**: These categories are for information only and aren't
validated against the total amount provided.
checkImage:
type: object
additionalProperties:
description: Any type
description: Object containing image of paper check.
checkNumber:
type: string
description: >-
A check number to be used in the ach transaction. **Required** for
payment method = 'check'.
currency:
type: string
description: >-
The currency for the transaction, `USD` or `CAD`. If your paypoint
is configured for CAD, you must send the `CAD` value in this field,
otherwise it defaults to USD, which will cause the transaction to
fail.
serviceFee:
type: number
format: double
description: >-
Service fee to be deducted from the total amount. This amount must
be a number, percentages aren't accepted. If you are using a
percentage-based fee schedule, you must calculate the value
manually.
splitFunding:
$ref: '#/components/schemas/type_:SplitFunding'
description: >-
Split funding instructions for the transaction. See [Split a
Transaction](/developers/developer-guides/money-in-split-funding)
for more.
totalAmount:
type: number
format: double
description: >-
Total amount to be charged. If a service fee is sent, then this
amount should include the service fee."
required:
- totalAmount
type_:Sequence:
type: string
type_:Signaturedata:
type: string
type_:Storedmethodid:
type: string
type_:StoredMethodUsageType:
type: string
type_:QueryPaymentData:
type: object
properties:
AccountExp:
$ref: '#/components/schemas/type_:Accountexp'
accountId:
$ref: '#/components/schemas/type_:Accountid'
AccountType:
$ref: '#/components/schemas/type_:Accounttype'
AccountZip:
$ref: '#/components/schemas/type_:Accountzip'
binData:
$ref: '#/components/schemas/type_:BinData'
HolderName:
$ref: '#/components/schemas/type_:Holdername'
Initiator:
$ref: '#/components/schemas/type_:Initiator'
MaskedAccount:
$ref: '#/components/schemas/type_:Maskedaccount'
orderDescription:
$ref: '#/components/schemas/type_:Orderdescription'
paymentDetails:
$ref: '#/components/schemas/type_:PaymentDetail'
Sequence:
$ref: '#/components/schemas/type_:Sequence'
SignatureData:
$ref: '#/components/schemas/type_:Signaturedata'
StoredId:
$ref: '#/components/schemas/type_:Storedmethodid'
description: Identifier of stored payment method used in transaction.
StoredMethodUsageType:
$ref: '#/components/schemas/type_:StoredMethodUsageType'
type_:InvoiceNumber:
type: string
type_:NetAmountstring:
type: string
type_:AdditionalDataString:
type: string
type_:Attachments:
type: array
items:
$ref: '#/components/schemas/type_:FileContent'
type_:BillPayOutData:
type: object
properties:
billId:
type: integer
format: int64
description: Bill ID in Payabli.
comments:
$ref: '#/components/schemas/type_:Comments'
description: >-
Any comments about bill. **For managed payouts, this field has a
limit of 100 characters**.
dueDate:
$ref: '#/components/schemas/type_:Datenullable'
description: Bill due date in format YYYY-MM-DD or MM/DD/YYYY.
invoiceDate:
$ref: '#/components/schemas/type_:Datenullable'
description: Bill date in format YYYY-MM-DD or MM/DD/YYYY.
invoiceNumber:
$ref: '#/components/schemas/type_:InvoiceNumber'
description: >-
Custom number identifying the bill. Must be unique in paypoint.
**Required** for new bill and when `billId` isn't provided.
netAmount:
$ref: '#/components/schemas/type_:NetAmountstring'
description: Net Amount owed in bill. Required when adding a bill.
discount:
type: string
description: Bill discount amount.
Terms:
$ref: '#/components/schemas/type_:Terms'
description: Description of payment terms.
AccountingField1:
$ref: '#/components/schemas/type_:AccountingField'
AccountingField2:
$ref: '#/components/schemas/type_:AccountingField'
AdditionalData:
$ref: '#/components/schemas/type_:AdditionalDataString'
attachments:
$ref: '#/components/schemas/type_:Attachments'
description: >-
Bill image attachment. Send the bill image as Base64-encoded string,
or as a publicly accessible link. For full details on using this
field with a payout authorization, see [the
documentation](/developers/developer-guides/pay-out-manage-payouts).
type_:QueryTransactionEventsEventData:
oneOf:
- type: object
additionalProperties:
description: Any type
- type: string
type_:QueryTransactionEvents:
type: object
properties:
EventData:
$ref: '#/components/schemas/type_:QueryTransactionEventsEventData'
description: >-
Any data associated to the event received from processor. Contents
vary by event type.
EventTime:
type: string
format: date-time
description: Date and time of event.
TransEvent:
type: string
description: >-
Event descriptor. See [TransEvent
Reference](/guides/pay-in-transevents-reference) for more details.
type_:Gatewayfield:
type: string
type_:HasVcardTransactions:
type: boolean
type_:IsSameDayACH:
type: boolean
type_:ScheduleId:
type: integer
format: int64
type_:SettlementStatusPayout:
type: string
type_:RiskFlagged:
type: boolean
type_:RiskFlaggedOn:
type: string
format: date-time
type_:RiskStatus:
type: string
type_:RiskReason:
type: string
type_:RiskAction:
type: string
type_:RiskActionCode:
type: integer
type_:PayoutProgram:
type: string
type_:TransactionOutQueryRecord:
type: object
properties:
IdOut:
type: integer
format: int64
description: Identifier of payout transaction.
CreatedAt:
$ref: '#/components/schemas/type_:CreatedAt'
Comments:
$ref: '#/components/schemas/type_:Comments'
description: Any comment or description for payout transaction.
Vendor:
$ref: '#/components/schemas/type_:VendorQueryRecord'
description: Vendor related to the payout transaction.
PaypointDbaname:
$ref: '#/components/schemas/type_:Dbaname'
PaypointLegalname:
$ref: '#/components/schemas/type_:Legalname'
Status:
type: integer
description: Internal status of transaction.
LastUpdated:
$ref: '#/components/schemas/type_:LastModified'
description: Timestamp when payment record was updated, in UTC.
TotalAmount:
type: number
format: double
description: Transaction total amount (including service fee or sub-charge).
NetAmount:
$ref: '#/components/schemas/type_:Netamountnullable'
FeeAmount:
$ref: '#/components/schemas/type_:FeeAmount'
Source:
$ref: '#/components/schemas/type_:Source'
ParentOrgName:
$ref: '#/components/schemas/type_:OrgParentName'
ParentOrgId:
$ref: '#/components/schemas/type_:Orgid'
BatchNumber:
type: string
description: The batch number for the payout transaction.
PaymentStatus:
type: string
description: Status of payout transaction.
PaymentMethod:
type: string
description: Method of payment applied to the transaction.
CardToken:
type: string
CheckNumber:
type: string
description: Paper check number related to payout transaction.
CheckData:
$ref: '#/components/schemas/type_:FileContent'
description: Object referencing to paper check image.
PaymentId:
$ref: '#/components/schemas/type_:PaymentIdString'
PaymentData:
$ref: '#/components/schemas/type_:QueryPaymentData'
Bills:
type: array
items:
$ref: '#/components/schemas/type_:BillPayOutData'
description: Events associated to this transaction.
Events:
type: array
items:
$ref: '#/components/schemas/type_:QueryTransactionEvents'
description: Events associated to this transaction.
externalPaypointID:
$ref: '#/components/schemas/type_:ExternalPaypointId'
EntryName:
$ref: '#/components/schemas/type_:Entrypointfield'
Gateway:
$ref: '#/components/schemas/type_:Gatewayfield'
BatchId:
type: string
description: ID of the batch the transaction belongs to.
HasVcardTransactions:
$ref: '#/components/schemas/type_:HasVcardTransactions'
IsSameDayACH:
$ref: '#/components/schemas/type_:IsSameDayACH'
ScheduleId:
$ref: '#/components/schemas/type_:ScheduleId'
SettlementStatus:
$ref: '#/components/schemas/type_:SettlementStatusPayout'
RiskFlagged:
$ref: '#/components/schemas/type_:RiskFlagged'
RiskFlaggedOn:
$ref: '#/components/schemas/type_:RiskFlaggedOn'
RiskStatus:
$ref: '#/components/schemas/type_:RiskStatus'
RiskReason:
$ref: '#/components/schemas/type_:RiskReason'
RiskAction:
$ref: '#/components/schemas/type_:RiskAction'
RiskActionCode:
$ref: '#/components/schemas/type_:RiskActionCode'
PayoutProgram:
$ref: '#/components/schemas/type_:PayoutProgram'
type_:BillingData:
type: object
properties:
accountNumber:
type: string
description: Account number for bank account.
bankAccountFunction:
type: integer
description: >-
Describes whether the bank account is used for deposits or
withdrawals in Payabli:
- `0`: Deposit
- `1`: Withdrawal
- `2`: Deposit and withdrawal
bankAccountHolderName:
$ref: '#/components/schemas/type_:BankAccountHolderName'
bankAccountHolderType:
$ref: '#/components/schemas/type_:BankAccountHolderType'
bankName:
$ref: '#/components/schemas/type_:BankName'
id:
type: integer
description: The bank's ID in Payabli.
routingAccount:
$ref: '#/components/schemas/type_:RoutingAccount'
typeAccount:
$ref: '#/components/schemas/type_:TypeAccount'
type_:Contacts:
type: object
properties:
contactEmail:
$ref: '#/components/schemas/type_:Email'
description: Contact email address.
contactName:
type: string
description: Contact name.
contactPhone:
type: string
description: Contact phone number.
contactTitle:
type: string
description: Contact title.
additionalData:
$ref: '#/components/schemas/type_:AdditionalDataString'
type_:ContactsField:
type: array
items:
$ref: '#/components/schemas/type_:Contacts'
type_:LocationCode:
type: string
type_:VendorPaymentMethod:
type: object
properties:
method:
type: string
description: Payment method type - "managed", "vcard", "check", or "ach"
storedMethodId:
type: string
description: >-
ID of the stored ACH payment method. Only applicable when method is
"ach". Required when using a previously saved ACH method when the
vendor has more than one saved method. See the [Payouts with saved
ACH payment
methods](/developers/developer-guides/pay-out-manage-payouts)
section for more details.
required:
- method
type_:VendorOutData:
type: object
properties:
additionalData:
$ref: '#/components/schemas/type_:AdditionalData'
Address1:
$ref: '#/components/schemas/type_:AddressNullable'
description: Vendor's address
Address2:
$ref: '#/components/schemas/type_:AddressAddtlNullable'
description: Additional line for vendor's address.
BillingData:
$ref: '#/components/schemas/type_:BillingData'
description: Object containing vendor's bank information.
City:
type: string
description: Vendor's city.
Contacts:
$ref: '#/components/schemas/type_:ContactsField'
description: Array of objects describing the vendor's contacts.
Country:
type: string
description: Vendor's country.
customerVendorAccount:
type: string
description: Account number of paypoint in the vendor side.
EIN:
type: string
description: >-
EIN/Tax ID for vendor. In reponses, this field is masked, and looks
like: `XXXXX6789`.
Email:
$ref: '#/components/schemas/type_:Email'
description: Vendor's email address. Required for vCard.
InternalReferenceId:
type: integer
format: int64
description: Internal identifier for global vendor account.
LocationCode:
$ref: '#/components/schemas/type_:LocationCode'
Mcc:
$ref: '#/components/schemas/type_:Mcc'
Name1:
type: string
description: Primary name for vendor. Required for new vendor.
Name2:
type: string
description: Secondary name for vendor.
payeeName1:
$ref: '#/components/schemas/type_:PayeeName'
payeeName2:
$ref: '#/components/schemas/type_:PayeeName'
PaymentMethod:
$ref: '#/components/schemas/type_:VendorPaymentMethod'
Phone:
type: string
description: Vendor's phone number
remitAddress1:
$ref: '#/components/schemas/type_:Remitaddress1'
remitAddress2:
$ref: '#/components/schemas/type_:Remitaddress2'
remitCity:
$ref: '#/components/schemas/type_:Remitcity'
remitCountry:
$ref: '#/components/schemas/type_:Remitcountry'
remitState:
$ref: '#/components/schemas/type_:Remitstate'
remitZip:
$ref: '#/components/schemas/type_:Remitzip'
State:
type: string
description: Vendor's state. Must be a 2 character state code.
VendorId:
$ref: '#/components/schemas/type_:Vendorid'
description: >-
Payabli identifier for vendor record. Required when `VendorNumber`
isn't included.
VendorNumber:
$ref: '#/components/schemas/type_:VendorNumber'
VendorStatus:
$ref: '#/components/schemas/type_:Vendorstatus'
Zip:
type: string
description: Vendor's zip code.
required:
- City
- Country
- EIN
- Name1
- Phone
- State
- Zip
type_:BillQueryRecord2:
type: object
properties:
AccountingField1:
oneOf:
- $ref: '#/components/schemas/type_:AccountingField'
- type: 'null'
AccountingField2:
oneOf:
- $ref: '#/components/schemas/type_:AccountingField'
- type: 'null'
AdditionalData:
type:
- object
- 'null'
additionalProperties:
type: string
description: Additional data associated with the bill.
BatchNumber:
type:
- string
- 'null'
description: Batch number associated with the bill.
billApprovals:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/type_:BillQueryRecord2BillApprovalsItem'
BillDate:
oneOf:
- $ref: '#/components/schemas/type_:Datenullable'
- type: 'null'
description: >-
Bill creation date in one of the accepted formats: YYYY-MM-DD,
MM/DD/YYYY.
billEvents:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/type_:GeneralEvents'
description: Events associated with the bill.
BillItems:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/type_:BillItem'
description: Array of items included in the bill.
BillNumber:
type:
- string
- 'null'
description: Bill number.
Comments:
type:
- string
- 'null'
description: Additional comments on the bill.
CreatedAt:
oneOf:
- $ref: '#/components/schemas/type_:CreatedAt'
- type: 'null'
description: Timestamp of when bill was created, in UTC.
Discount:
type:
- number
- 'null'
format: double
description: Discount amount applied to the bill.
DocumentsRef:
type:
- string
- 'null'
description: Reference to documents associated with the bill.
DueDate:
oneOf:
- $ref: '#/components/schemas/type_:Datenullable'
- type: 'null'
description: >-
Bill due date in one of the accepted formats: YYYY-MM-DD,
MM/DD/YYYY.
EndDate:
oneOf:
- $ref: '#/components/schemas/type_:Datenullable'
- type: 'null'
description: End date for the bill.
EntityID:
type:
- string
- 'null'
description: Entity identifier associated with the bill.
externalPaypointID:
oneOf:
- $ref: '#/components/schemas/type_:ExternalPaypointId'
- type: 'null'
Frequency:
oneOf:
- $ref: '#/components/schemas/type_:Frequency'
- type: 'null'
description: Frequency for scheduled bills. Applied only in `Mode` = 1.
IdBill:
type:
- integer
- 'null'
format: int64
description: Identifier of the bill.
LastUpdated:
oneOf:
- $ref: '#/components/schemas/type_:DatetimeNullable'
- type: 'null'
description: Timestamp of when bill was last updated, in UTC.
LotNumber:
type:
- string
- 'null'
description: Lot number associated with the bill.
Mode:
type:
- integer
- 'null'
description: >-
Bill mode: value `0` for single/one-time bills, `1` for scheduled
bills.
NetAmount:
type:
- number
- 'null'
format: double
description: Net amount of the bill.
ParentOrgId:
type:
- integer
- 'null'
format: int64
description: Parent organization identifier.
ParentOrgName:
oneOf:
- $ref: '#/components/schemas/type_:OrgParentName'
- type: 'null'
PaymentId:
oneOf:
- $ref: '#/components/schemas/type_:PaymentIdString'
- type: 'null'
PaymentMethod:
oneOf:
- $ref: '#/components/schemas/type_:BillQueryRecord2PaymentMethod'
- type: 'null'
description: Preferred payment method used.
paylinkId:
type:
- string
- 'null'
description: Paylink identifier associated with the bill.
PaypointDbaname:
oneOf:
- $ref: '#/components/schemas/type_:Dbaname'
- type: 'null'
description: The paypoint's DBA name.
PaypointEntryname:
type:
- string
- 'null'
description: Entry name of the paypoint.
PaypointLegalname:
oneOf:
- $ref: '#/components/schemas/type_:Legalname'
- type: 'null'
description: The paypoint's legal name.
Source:
type:
- string
- 'null'
description: Source of the bill.
Status:
oneOf:
- $ref: '#/components/schemas/type_:Billstatus'
- type: 'null'
Terms:
oneOf:
- $ref: '#/components/schemas/type_:Terms'
- type: 'null'
description: >-
The payment terms for invoice. If no terms were defined initially,
then response data for this field will default to `N30`.
TotalAmount:
type:
- number
- 'null'
format: double
description: Total amount of the bill including taxes and fees.
Transaction:
oneOf:
- $ref: '#/components/schemas/type_:TransactionOutQueryRecord'
- type: 'null'
description: MoneyOut transaction associated to the bill.
Vendor:
oneOf:
- $ref: '#/components/schemas/type_:VendorOutData'
- type: 'null'
required:
- AccountingField1
- AccountingField2
- AdditionalData
- BatchNumber
- billApprovals
- BillDate
- billEvents
- BillItems
- BillNumber
- Comments
- CreatedAt
- Discount
- DocumentsRef
- DueDate
- EndDate
- EntityID
- externalPaypointID
- Frequency
- IdBill
- LastUpdated
- LotNumber
- Mode
- NetAmount
- ParentOrgId
- ParentOrgName
- PaymentId
- PaymentMethod
- paylinkId
- PaypointDbaname
- PaypointEntryname
- PaypointLegalname
- Source
- Status
- Terms
- TotalAmount
- Transaction
- Vendor
type_:BillQueryResponse:
type: object
properties:
Summary:
$ref: '#/components/schemas/type_:BillQueryResponseSummary'
description: Summary statistics for the bill query response.
Records:
type: array
items:
$ref: '#/components/schemas/type_:BillQueryRecord2'
description: Array of bill records returned by the query.
```
## SDK Code Examples
```python ListBillsEntry
from payabli import payabli
client = payabli(
api_key="YOUR_API_KEY",
)
client.bill.list_bills(
entry="8cfec329267",
from_record=251,
limit_record=0,
sort_by="desc(field_name)",
)
```
```typescript ListBillsEntry
import { PayabliClient } from "@payabli/sdk-node";
const client = new PayabliClient({ apiKey: "YOUR_API_KEY" });
await client.bill.listBills("8cfec329267", {
fromRecord: 251,
limitRecord: 0,
sortBy: "desc(field_name)"
});
```
```go ListBillsEntry
import (
context "context"
option "github.com/payabli/sdk-go/option"
sdkgo "github.com/payabli/sdk-go"
sdkgoclient "github.com/payabli/sdk-go/client"
)
client := sdkgoclient.NewClient(
option.WithApiKey(
"",
),
)
response, err := client.Bill.ListBills(
context.TODO(),
"8cfec329267",
&sdkgo.ListBillsRequest{
FromRecord: sdkgo.Int(
251,
),
LimitRecord: sdkgo.Int(
0,
),
SortBy: sdkgo.String(
"desc(field_name)",
),
},
)
```
```csharp ListBillsEntry
using PayabliApi;
var client = new PayabliApiClient("API_KEY");
await client.Bill.ListBillsAsync(
"8cfec329267",
new ListBillsRequest
{
FromRecord = 251,
LimitRecord = 0,
SortBy = "desc(field_name)",
}
);
```
```ruby ListBillsEntry
require 'uri'
require 'net/http'
url = URI("https://api-sandbox.payabli.com/api/Query/bills/8cfec329267?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["requestToken"] = ''
response = http.request(request)
puts response.read_body
```
```java ListBillsEntry
HttpResponse response = Unirest.get("https://api-sandbox.payabli.com/api/Query/bills/8cfec329267?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29")
.header("requestToken", "")
.asString();
```
```php ListBillsEntry
request('GET', 'https://api-sandbox.payabli.com/api/Query/bills/8cfec329267?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29', [
'headers' => [
'requestToken' => '',
],
]);
echo $response->getBody();
```
```swift ListBillsEntry
import Foundation
let headers = ["requestToken": ""]
let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Query/bills/8cfec329267?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
```