Financials
Record Sources

Register Record Source

Register a source, or restore one that was deleted.

Restoring rather than refusing is forced by the key having to keep meaning one thing: published documents and duplicate links name a source by key, so it is never freed for something else. A restore brings the records back with it and does not demand a fresh full import.

post/api/v1/financials/record_sources

Request

  • Base URL: https://api.withaccend.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.withaccend.com/api/v1/financials/record_sources
  • Auth: HTTP bearer

Request body

source_keystring required

The name a policy document points at: lower-case letters, digits and underscores, starting with a letter. Pinned forever by the first published document that names it, so it cannot be renamed.

labelstring required
external_ids_are_customer_idsboolean

True only if this source's external ids are the SAME ids sent as external_customer_id when creating customers. When true the search can recognise and exclude an applicant's own record; when false it cannot, so matches from this source are always reviewed by a person rather than acted on automatically.

Response

Successful Response

source_keystring required
labelstring required
statestring required

uninitialized | importing | ready | incomplete. Only 'ready' is searched: a source mid-import or left partially loaded is reported as unusable to the workflow rather than read as 'no matches'.

external_ids_are_customer_idsboolean required
open_import_idstring nullable
record_countinteger
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.