GET /api/account/bank-transactions/{id}/payable-suggestions

get/api/account/bank-transactions/{id}/payable-suggestions

Example request

GET https://api.jupiter-erp.com/api/account/bank-transactions/example-id/payable-suggestions

Code

curl -X GET 'https://api.jupiter-erp.com/api/account/bank-transactions/example-id/payable-suggestions' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'X-Account-Uuid: YOUR_ACCOUNT_UUID' \
  -H 'Accept: application/json'

Parameters

Name	In	Required	Description
id	path	yes	Bank transaction id

Responses

200OK

ModelListPayableDocumentSuggestions200Response

Field

Type

Description

data*

object[]

array

Elements

Field

Type

Description

amount_open_cents*

integer

Open amount on the document in cents

amount_total_cents*

integer

Total document amount in cents (e.g. sum gross or dunning fee)

contact_avatar

object

Field	Type	Description
url	string	—

contact_company_name

string

—

contact_first_name

string

—

contact_id

integer

—

contact_last_name

string

—

contact_name

string

—

contact_number

integer

—

currency_code

string

—

document_date

string (date)

—

document_subject

string

Document subject or title when available (invoice, credit note, dunning)

match_reasons*

string[]

Why this document was suggested (amount exact match, counterparty name, and/or document number in reference/memo)

array

Elements

string

amount
counterparty
document_number

payable_id*

integer

—

payable_label*

string

—

payable_type*

string

Invoice
CreditNote
Dunning

suggested_amount_cents*

integer

Suggested booking amount in cents (positive, capped by open amount and assignable remainder)

Example response

{
  "data": [
    {
      "payable_type": "Invoice",
      "payable_id": 0,
      "payable_label": "string",
      "contact_id": 0,
      "contact_name": "string",
      "contact_first_name": "string",
      "amount_total_cents": 0,
      "amount_open_cents": 0,
      "match_reasons": [
        "amount"
      ],
      "suggested_amount_cents": 0
    }
  ]
}

404Bank transaction not found

No JSON schema documented.

Bank Transactions

Questions about integration?