Skip to main content

​
BankAccount Object

Represents a bank account used for financial transactions.
​
id
number
required
Unique identifier for the bank account
​
name
string
required
Descriptive name for the account
​
account_number
string
required
Bank account number
​
account_type
string
required
Type of bank account (e.g., “CORRIENTE”, “AHORRO”)
​
account_owner
string
required
Name of the account holder
​
bank
Bank
required
Associated bank information
​
cards
Card[]
required
Payment cards linked to this account
​
company
Company
required
Company that owns the account
​
created_by
string
required
User who created the account record
​
updated_by
string
required
User who last updated the account record

​
Bank Object

Information about a banking institution.
​
id
number
required
Unique identifier for the bank
​
name
string
required
Bank name
​
type
string
required
Type of banking institution
​
created_by
string
required
User who created the bank record
​
updated_by
string
required
User who last updated the bank record

​
Card Object

Represents a payment card linked to a bank account.
​
id
number
required
Unique identifier for the card
​
name
string
required
Card name or description
​
card_number
string
required
Card number (may be masked)
​
type
string
required
Card type (e.g., “CREDITO”, “DEBITO”)
​
bank_account
BankAccount
required
Associated bank account
​
created_by
string
required
User who created the card record
​
updated_by
string
required
User who last updated the card record

​
Example

{
  "id": 3,
  "name": "Cuenta Corriente USD - Operations",
  "account_number": "0102-0123-45-6789012345",
  "account_type": "CORRIENTE",
  "account_owner": "SIGEAC Aviation Services C.A.",
  "bank": {
    "id": 1,
    "name": "Banco Nacional de Comercio",
    "type": "COMERCIAL",
    "created_by": "admin",
    "updated_by": "admin"
  },
  "cards": [
    {
      "id": 1,
      "name": "Corporate Card",
      "card_number": "****-****-****-1234",
      "type": "CREDITO",
      "created_by": "admin",
      "updated_by": "admin"
    }
  ],
  "company": {
    "id": 1,
    "name": "SIGEAC Aviation",
    "rif": "J-12345678-9"
  },
  "created_by": "admin",
  "updated_by": "finance_manager"
}

Build docs developers (and LLMs) love

Get started for freeTalk to us