Skip to main content
POST
Create an income record

Authorizations

Authorization
string
header
required

Workspace API key sent as a bearer token: Authorization: Bearer failfast_.... Create keys in Settings -> Workspace -> API Keys.

Body

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

operation_date
string<date-time>
required
type
enum<string>
required
  • INV - Invoice
  • ADV - Advance
  • OTH - Other
  • REF - Refund
  • LCP - Loan CxP
  • CHK - Postdated Check
Available options:
INV,
ADV,
OTH,
REF,
LCP,
CHK
total_value
string<decimal>
required
Pattern: ^-?\d{0,14}(?:\.\d{0,6})?$
operation
string<uuid>
required
branch_office
string<uuid>
required
stakeholder
string<uuid>
required
cost_center
string<uuid>
required
custom_fields
unknown
operation_number
integer
default:0
Required range: 0 <= x <= 2147483647
description
string | null
operation_status
enum<string>
  • PR - Provisional
  • CO - Complete
  • ER - Error
Available options:
PR,
CO,
ER
status_description
string | null
is_bank_destination
boolean
deposit_reference
string | null
deposit_date
string<date> | null
is_directly_created
boolean
market_exchange_rate
string<uuid> | null
customer_detail
string<uuid> | null
category
string<uuid> | null
bank_account
string<uuid> | null
cash_register
string<uuid> | null

Response

201 - application/json
message
string
required

Human-readable outcome of the request.

error
boolean
required

true when the request failed.

Example:

false

data
object
required

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.