POST
/
accounting
/
invoice_payments
/
all
curl --request POST \
  --url https://api.rootfi.dev/accounting/invoice_payments/all \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "take": 10,
  "skip": 0,
  "orderBy": {
    "amount": "asc"
  },
  "filter": {
    "contact_id": {
      "eq": "1234567890123456789"
    }
  }
}'
{
  "data": {
    "data": [
      {
        "account_id": "1234567890123456789",
        "amount": 105,
        "contact_id": "1234567890123456789",
        "credit_note_id": "1234567890123456789",
        "currency": {
          "data": {
            "code": null,
            "exchange_rate": null,
            "is_base_currency": null,
            "name": null,
            "platform_id": null,
            "symbol": null,
            "updated_at": null
          }
        },
        "currency_id": null,
        "currency_rate": 1,
        "document_number": null,
        "invoice": {
          "data": {
            "amount_due": 0,
            "contact_id": "1",
            "currency": {
              "data": {
                "code": null,
                "exchange_rate": null,
                "is_base_currency": null,
                "name": null,
                "platform_id": null,
                "symbol": null,
                "updated_at": null
              }
            },
            "currency_id": null,
            "currency_rate": null,
            "document_number": "1025",
            "due_date": "2023-01-01T00:00:00.000Z",
            "memo": null,
            "platform_id": "71",
            "posted_date": "2022-12-02T00:00:00.000Z",
            "sales_order_ids": null,
            "status": "PAID",
            "sub_total": 205,
            "tax_amount": 0,
            "total_amount": 205,
            "total_discount": null,
            "updated_at": "2023-01-18T00:00:00.000Z"
          }
        },
        "invoice_id": "1234567890123456789",
        "memo": "Amy claims the pest control did not occur",
        "payment_date": "2022-12-27T00:00:00.000Z",
        "payment_id": "1234567890123456789",
        "payment_mode": null,
        "platform_id": "1234567890123456789",
        "rootfi_company_id": 1672,
        "rootfi_created_at": "2023-10-25T13:39:41.216Z",
        "rootfi_id": 443583,
        "rootfi_integration_type": "ZOHO_BOOKS",
        "rootfi_organisation_id": 1,
        "rootfi_updated_at": "2023-10-25T13:39:41.201Z",
        "updated_at": "2023-01-18T00:00:00.000Z"
      }
    ],
    "total_count": 1
  },
  "request_id": "7a1c0e42-9f85-4d6e-bb5d-358a72913c0b",
  "request_timestamp": "2023-10-25T13:39:41.201Z",
  "response_timestamp": "2023-10-25T13:39:41.201Z"
}

The Invoice Payments Data Model streamlines the representation and management of invoice payment information across multiple accounting platforms.

Authorizations

api_key
string
headerrequired

Body

application/json
filter
object
orderBy
object
skip
integer | null
take
integer | null

Response

200 - application/json
data
object
required
request_id
string
required

The unique ID of the request

request_timestamp
string
required

The time at which the request was received by the server

response_timestamp
string
required

The time at which the response was sent by the server