Reconciliation items

List settle targets

Returns a page of bills this bank entry could be paying off. Requires the reconciliations:read permission.

GET
https://services.magicdoor.com/accounting/company-portal/reconciliations/items/{reconciliationItemId}/settle-targets

Authorization

Authorizationstringrequired
Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Path parameters

reconciliationItemIdstringrequired

Snowflake id of the reconciliation item.

example: 1830472847398410100

Query parameters

identitystringrequired

Which kind of bill to list. vendorBill is the only supported value, and the parameter is required — omitting it is a 400.

example: vendorBill
pageinteger

Which page to return, starting at 1.

default: 1
pageSizeinteger

How many bills per page, between 1 and 100.

default: 50
vendorIdstring

Only bills from this vendor.

searchstring

Free-text search across the bills, 2 to 500 characters.

Response

200 · A page of bills that can be settled.

itemsSettleTarget[]

Bills you can name in targets on a settle resolve.

totalCountinteger

How many bills match in total.

totalPagesinteger

How many pages that is at this pageSize.

pageinteger

The page number that was returned.

pageSizeinteger

How many bills a full page holds.

400 · `identity` was not supplied, `search` is shorter than 2 or longer than 500 characters, or a pagination value is out of range.

401 · The access token is missing, expired, or not for this company.

403 · The caller does not hold the `reconciliations:read` permission.

404 · No reconciliation item with this id belongs to the caller's company.