Get external references

Allowed Scopes: experimental:external-reference:read

Returns the IDs Spendesk entities have in an external system (ERP), as one entry per
(entity, external ID) pair. Filter by entityIds to get the external IDs of entities you
already know, or by externalIds to resolve external IDs back to Spendesk entities — at
least one of the two is required.

Where the reference is stored is an implementation detail. Reference entities (supplier,
employee, analyticalField, analyticalFieldValue, costCenter, expenseCategory,
customField) are served from the entity registry; exportable entities (payable,
settlementAllocation, walletLoad, bankFee, documentaryEvidenceAttachment,
creditNoteAllocation) from the export state, where only exported entities carry an external
ID; and the account kinds from the chart of accounts.

The chart of accounts is addressed one account type at a time — bankAccount,
expenseAccount, taxAccount, supplierAccount, employeeAccount or
reverseChargeAccount — each returning only accounts of that type. An account's type is
part of what identifies it, so there is no unqualified spelling. The suffix is required
because supplier and employee already name reference entities. For these, entityId is the
account id and externalName is the account name; archived accounts and accounts without an
external ID are never returned, and provider and source are always null because an
account row records no provenance — so filtering by either returns no accounts.

source tells you who recorded the mapping: native_integration means a native ERP sync
owns it and keeps it up to date, public_api means it was set through this API.

Cached for 86400 seconds.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum
required

Kind of Spendesk entity. Reference entities: supplier, employee, analyticalField, analyticalFieldValue, costCenter, expenseCategory, customField. Chart of accounts, one account type at a time: bankAccount, expenseAccount, taxAccount, supplierAccount, employeeAccount, reverseChargeAccount — each also asserts the target account's own type. Exportable entities: payable, settlementAllocation, walletLoad, bankFee, documentaryEvidenceAttachment, creditNoteAllocation.

string | array

Filter by Spendesk entity ids (comma-separated).

string | array

Filter by external ids (comma-separated).

string
length ≥ 1

Filter by external system.

string
enum

Filter by who recorded the mapping.

Allowed:
integer
≥ 1

Cap the number of returned references. Not a paging cursor.

Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json