API Reference

Create forecasted transaction batch

post
https://api.atlar.com/analytics/v2beta/forecasted-transaction-batches

Create a batch of forecasted transactions. A batch may contain at most 15000 records; requests exceeding this limit are rejected.

Body Params
requests
array of objects
required
length between 1 and 15000
requests*
parent
required

All forecasted transactions must be associated with either an account or an entity.

amount
required
date
required

full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21.

string
required
origin
object

The origin of this forecasted transaction, e.g. manual user input or AP/AR data.

counterparty
object
metadata
object | null

Optional key-value metadata. Set the cash-flow category with key atlar.category (e.g. {"atlar.category": "Sales"}); there is no separate category field.

string
^[a-zA-Z0-9._\-+=]{1,64}$

External ID is optional to use, but if used, the Atlar platform will persist it, index it, as well as require it to be unique across all resources. It is possible to retrieve a resource using the external ID using the prefix external:.

string
^[a-zA-Z0-9._\-+=]{1,64}$

External ID is optional to use, but if used, the Atlar platform will persist it, index it, as well as require it to be unique across all resources. It is possible to retrieve a resource using the external ID using the prefix external:.

metadata
object | null

Metadata is a string-string key-value container that
can be used to store information known at the time of resource
creation. This can be retrieved later on, for instance when a
payment or expected transaction is reconciled with the booked
transaction on the bank statement.

Metadata can have at most 20 entries. Keys may have a
maximum length of 64 chars and values a maximum length of 512
chars.

By default, this field is optional. It is possible to make it
required in the Atlar Dashboard by visiting the Metadata keys
page. Requirement rules
can be specified per API resource. Both the Dashboard and the
API will then enforce these rules and give validation errors
when the required fields are not set.

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated about 3 hours ago

Did this page help you?
Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 3 hours ago

Did this page help you?