Skip to main content
GuidesAPI Reference

List Bills

GET 
/accounting/bills

Returns a list of Bills.

Request​

Query Parameters

    credentialId stringrequired

    The ID of the credential.

    pageNumber int32

    The page number of the results. Default is 1.

    pageSize int32

    The maximum number of results to show on a page. Default is 50. Maximum is 100.

    remoteId string

    Used to filter bills with this third-party application ID.

    vendorId string

    Used to filter bills with this vendor ID.

    billNumber string

    Used to filter bills with the exact bill number.

    billNumberContains string

    Used to filter bills whose bill numbers contain the provided value.

    billNumberNotEquals string

    Used to filter bills whose bill number to exclude.

    issueDate date

    Used to filter bills with the exact issue date. Format: YYYY-MM-DD

    dueDate date

    Used to filter bills with the exact due date. Format: YYYY-MM-DD

    paidOnDate date

    Used to filter bills with the exact paid on date. Format: YYYY-MM-DD

    memo string

    Used to filter bills with the exact memo.

    memoContains string

    Used to filter bills whose memos contain the provided value.

    memoNotEquals string

    Used to filter bills whose memo to exclude.

    companyId string

    Used to filter bills with this company ID.

    currency string

    Used to filter bills with the exact currency.

    exchangeRate float

    Used to filter bills with the exact exchange rate.

    totalDiscount float

    Used to filter bills with the exact total discount.

    totalDiscountMin float

    Used to filter bills with the minimum total discount.

    totalDiscountMax float

    Used to filter bills with the maximum total discount.

    totalDiscountNotEquals float

    Used to filter bills whose total discount to exclude.

    subTotal float

    Used to filter bills with the exact subtotal.

    subTotalMin float

    Used to filter bills with the minimum subtotal.

    subTotalMax float

    Used to filter bills with the maximum subtotal.

    subTotalNotEquals float

    Used to filter bills whose subtotal to exclude.

    billStatus string

    Used to filter bills with the exact bill status.

    totalTaxAmount float

    Used to filter bills with the exact total tax amount.

    totalTaxAmountMin float

    Used to filter bills with the minimum total tax amount.

    totalTaxAmountMax float

    Used to filter bills with the maximum total tax amount.

    totalTaxAmountNotEquals float

    Used to filter bills whose total tax amount to exclude.

    totalAmount float

    Used to filter bills with the exact total amount.

    totalAmountMin float

    Used to filter bills with the minimum total amount.

    totalAmountMax float

    Used to filter bills with the maximum total amount.

    totalAmountNotEquals float

    Used to filter bills whose total amount to exclude.

    balance float

    Used to filter bills with the exact balance.

    balanceMin float

    Used to filter bills with the minimum balance.

    balanceMax float

    Used to filter bills with the maximum balance.

    balanceNotEquals float

    Used to filter bills whose balance to exclude.

    remoteCreatedAtMin date

    Filter objects created in the third-party application after a specified date.

    remoteCreatedAtMax date

    Filter objects created in the third-party application before a specified date.

    remoteUpdatedAtMin date

    Filter objects last updated in the third-party application after a specified date.

    remoteUpdatedAtMax date

    Filter objects last updated in the third-party application before a specified date.

    createdAtMin date

    Filter objects created after a specified date.

    createdAtMax date

    Filter objects created before a specified date.

    updatedAtMin date

    Filter objects last updated after a specified date.

    updatedAtMax date

    Filter objects last updated before a specified date.

Header Parameters

    Authorization stringrequired

    Default value: bearer YOUR_API_KEY

Responses​

200

Schema

    any

Loading...