Skip to main content
POST
Node.js

Authorizations

Authorization
string
header
required

A secret API key, made under Developers in the dashboard: Authorization: Bearer shoply_sk_...

Headers

Idempotency-Key
string

A word of your own for this one change, up to 180 letters, digits, dots, dashes, underscores and colons. Sent again with the same key, the request is not carried out twice: the first answer comes back, with Idempotent-Replay: true.

Path Parameters

storeId
string
required

The store's ID. A key reaches the store it was made in: GET /key answers which.

Body

application/json
payee
string
required

Who is paid, up to 120 characters.

amount
number
required

How much each time, in the store's currency.

cadence
enum<string>
required

How often it comes round.

Available options:
month,
year
nextOn
string
required

The day it is next due, as YYYY-MM-DD.

method
enum<string>

How it is paid.

Available options:
card,
bank,
crypto,
paypal,
cash,
other
categoryId
string

The expense category it is filed in.

note
string

A note, up to 255 characters.

reference
string

A reference, up to 160 characters.

Response

It worked.

success
boolean
message
unknown
code
unknown
data
object