Skip to main content
GuidesAPI Reference

List Payments

GET 
/accounting/payments

Returns a list of Payments.

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 payments with this third-party application ID.

    transactionDate string

    Used to filter payments with the exact transaction date. Format: YYYY-MM-DD

    customerId string

    Used to filter payments with this customer ID.

    vendorId string

    Used to filter payments with this vendor ID.

    accountId string

    Used to filter payments with this account ID.

    currency string

    Used to filter payments with the exact currency.

    exchangeRate float

    Used to filter payments with the exact exchange rate.

    companyId string

    Used to filter payments with this company ID.

    totalAmount float

    Used to filter payments with the exact total amount.

    totalAmountMin float

    Used to filter payments with the minimum total amount.

    totalAmountMax float

    Used to filter payments with the maximum total amount.

    totalAmountNotEquals float

    Used to filter payments whose total amount to exclude.

    remoteCreatedAtMin date

    Used to filter records created after this datetime in the third-party application.

    remoteCreatedAtMax date

    Used to filter records created before this datetime in the third-party application.

    remoteUpdatedAtMin date

    Used to filter records updated after this datetime in the third-party application.

    remoteUpdatedAtMax date

    Used to filter records updated before this datetime in the third-party application.

    createdAtMin date

    Used to filter records created after this datetime.

    createdAtMax date

    Used to filter records created before this datetime.

    updatedAtMin date

    Used to filter records updated after this datetime.

    updatedAtMax date

    Used to filter records updated before this datetime.

Header Parameters

    Authorization stringrequired

    Default value: bearer YOUR_API_KEY

Responses​

200

Schema

    payments

    object[]

  • Array [

    • id string
    remoteId string
    transactionDate string
    customerId string
    vendorId string
    accountId string
    currency string
    exchangeRate integer

    Default value: 0

    companyId
    totalAmount integer

    Default value: 0

    trackingCategoryIds array
    remoteCreatedAt string
    remoteUpdatedAt string
    remoteDeleted boolean

    Default value: true

    createdAt string
    updatedAt string

  • ]

Loading...