Businesses
- Business
- Financial Accounts
- Documents
- Scoped Authentication
- Configuration
- Tasks & Notifications
Financial Activity
- Accounts Receivable
- Accounts Payable
- Bank Transactions
- General Ledger
- Account Identifier
- Chart of Accounts object
- GETRetrieve Chart of Accounts
- GETList Account Balances
- Accounts
- Journal Entries
- Custom Journal Entries
- Custom journal entry object
- GETList custom journal entries
- POSTCreate custom journal entry
- POSTCreate multiple custom journal entries
- GETFetch custom journal entry
- PUTUpdate custom journal entry
- DELReverse custom journal entry
- POSTTag multiple custom journal entries
- DELRemove tags from multiple custom journal entries
- GETFetch Journal Entry
- GETList Journal Entries
- POSTReverse Journal Entry
- Tags
Accounting Reports
- Profit and Loss
- Balance Sheet
- Cash Flow Statement
Platform Configuration
- Plaid
- SMS
Activity Metrics
- Platform wide activity
- Business Activity
Create custom journal entry
Creates a new custom journal entry for the specified business. The credits and debits must balance.
curl --request POST \
--url https://sandbox.layerfi.com/v1/businesses/{businessId}/custom-journal-entries/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"external_id": "<string>",
"entry_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"memo": "<string>",
"line_items": [
{
"external_id": "<string>",
"account_identifier": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"amount": 123,
"direction": "CREDIT",
"memo": "<string>",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_external_id": "<string>",
"vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vendor_external_id": "<string>"
}
],
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_external_id": "<string>",
"vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vendor_external_id": "<string>",
"tags": [
{
"key": "Location",
"value": "MainStreet"
}
]
}'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_id": "<string>",
"created_by": "<string>",
"memo": "<string>",
"entry_id": "<string>",
"customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_id": "31415926535",
"individual_name": "<string>",
"company_name": "<string>",
"email": "<string>",
"mobile_phone": "<string>",
"office_phone": "<string>",
"address_string": "<string>",
"notes": "<string>",
"status": "ACTIVE",
"transaction_tags": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"key": "ExampleTagKey",
"value": "ExampleTagValue",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
]
},
"vendor": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_id": "<string>",
"individual_name": "<string>",
"company_name": "<string>",
"email": "<string>",
"mobile_phone": "<string>",
"office_phone": "<string>",
"address_string": "<string>",
"notes": "<string>",
"status": "ACTIVE",
"transaction_tags": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"key": "ExampleTagKey",
"value": "ExampleTagValue",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
]
},
"line_items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_id": "<string>",
"memo": "<string>",
"line_item_id": "<string>"
}
],
"entry": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ledger_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent": "SMS",
"entry_type": "BANK",
"date": "2023-11-07T05:31:56Z",
"entry_at": "2023-11-07T05:31:56Z",
"reversal_of_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reversal_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"line_items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account": {
"id": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"name": "Current Assets",
"stable_name": {
"type": "StableName",
"stable_name": "CURRENT_ASSETS"
},
"normality": "CREDIT",
"account_type": {
"value": "ASSET",
"display_name": "Asset"
},
"account_subtype": {
"value": "CURRENT",
"display_name": "Current Assets"
}
},
"amount": 123,
"direction": "CREDIT",
"entry_at": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z"
}
]
},
"transaction_tags": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"key": "ExampleTagKey",
"value": "ExampleTagValue",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Content-Type must be set to application/json
Path Parameters
The UUID of the business to create the custom journal entry for
Body
When the journal entry should be recorded effective in the ledger.
Identifier of the user or system that created the journal entry.
Description or memo of the journal entry.
Line items for the journal entry. The credits and debits must balance.
Amount for the line item in cents.
Direction of the ledger entry.
CREDIT, DEBIT External ID for the line item within your platform.
Optional memo field for adding notes about the line item.
ID of the customer to associate with the line item.
External ID of the customer to associate with the line item.
ID of the vendor to associate with the line item.
External ID of the vendor to associate with the line item.
External ID for the journal entry within your platform. Idempotency key.
ID of the customer to associate with the journal entry.
External ID of the customer to associate with the journal entry.
ID of the vendor to associate with the journal entry.
External ID of the vendor to associate with the journal entry.
Response
Unique identifier for the journal entry.
Identifier of the user or system that created the journal entry.
Description or memo of the journal entry.
ID of the ledger entry.
The ledger entry associated with this journal entry.
Unique identifier of the journal entry.
ID of the business associated with this journal entry
ID of the general ledger containing this journal entry.
Entity that created the journal entry.
SMS, API, LAYER_AUTO, LAYER_MANUAL Type of entry.
BANK, MANUAL, OPENING_BALANCE Date the ledger entry was recorded at.
Timestamp of the financial transaction associated with the line item.
ID of the ledger entry this is a reversal of
ID of the reversal object associated with this entry
List of child line items associated with this entry
Unique identifier of the ledger account line item.
ID of the Journal entry the ledger account line item was part of.
Simplified Ledger Account object containing this line item.
Name of the account
"Current Assets"
CREDIT, DEBIT CURRENT, FIXED, ACCOUNTS_RECEIVABLE, LONG_TERM, ACCOUNTS_PAYABLE, CREDIT_CARD, OWNERS_EQUITY, PRODUCT_INCOME, SERVICE_INCOME, DIRECT_LABOR, MATERIAL, OVERHEAD, ADVERTISING_AND_PROMOTION, AUTOMOTIVE_EXPENSE, BANK_FEES, CHARITABLE_CONTRIBUTIONS, COMMISSIONS_AND_FEES, DUES_AND_SUBSCRIPTIONS, INSURANCE, INTEREST, LEGAL_AND_PROFESSIONAL_FEES, LICENSES, MEALS_AND_ENTERTAINMENT, OFFICE_SUPPLIES, PAYROLL_ADMIN, PAYROLL_BENEFITS, PAYROLL_TAXES, PHONE_AND_INTERNET, RENT_OR_LEASE, REPAIRS_AND_MAINTENANCE, TAXES_AND_LICENSES, TRAVEL, UTILITIES, DEPRECIATION Display name of the account subtype
"Current Assets"
Amount of the financial transaction associated with the line item
Direction of line item.
CREDIT, DEBIT Timestamp of the financial transaction associated with the line item.
Timestamp when ledger entry was added to the ledger account.
Tags associated with the journal entry.
ID for the tag
Key for the tag
"ExampleTagKey"
Value for the tag
"ExampleTagValue"
When the tag was created
When the tag was last updated
When the tag was deleted
External ID of the journal entry in your system.
The customer associated with this journal entry, if any.
Unique identifier for the customer.
Unique ID of the customer in your system for linking purposes. Idempotency key.
"31415926535"
Full name of the individual customer or contact at a corporate customer.
Name of the company customer.
Email address of the customer.
Mobile phone number of the customer.
Office phone number of the customer.
Address of the customer.
Notes about the customer.
Status of the customer. Possible values: ACTIVE, ARCHIVED.
"ACTIVE"
ID for the tag
Key for the tag
"ExampleTagKey"
Value for the tag
"ExampleTagValue"
When the tag was created
When the tag was last updated
When the tag was deleted
The vendor associated with this journal entry, if any.
Unique identifier for the vendor.
Unique ID of the vendor in your system for linking purposes. Idempotency key.
Full name of the individual vendor or contact at a corporate vendor.
Name of the company vendor.
Email address of the vendor.
Mobile phone number of the vendor.
Office phone number of the vendor.
Address of the vendor.
Notes about the vendor.
Status of the vendor.
ACTIVE, ARCHIVED ID for the tag
Key for the tag
"ExampleTagKey"
Value for the tag
"ExampleTagValue"
When the tag was created
When the tag was last updated
When the tag was deleted
Line items for the journal entry.
curl --request POST \
--url https://sandbox.layerfi.com/v1/businesses/{businessId}/custom-journal-entries/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"external_id": "<string>",
"entry_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"memo": "<string>",
"line_items": [
{
"external_id": "<string>",
"account_identifier": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"amount": 123,
"direction": "CREDIT",
"memo": "<string>",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_external_id": "<string>",
"vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vendor_external_id": "<string>"
}
],
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_external_id": "<string>",
"vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vendor_external_id": "<string>",
"tags": [
{
"key": "Location",
"value": "MainStreet"
}
]
}'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_id": "<string>",
"created_by": "<string>",
"memo": "<string>",
"entry_id": "<string>",
"customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_id": "31415926535",
"individual_name": "<string>",
"company_name": "<string>",
"email": "<string>",
"mobile_phone": "<string>",
"office_phone": "<string>",
"address_string": "<string>",
"notes": "<string>",
"status": "ACTIVE",
"transaction_tags": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"key": "ExampleTagKey",
"value": "ExampleTagValue",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
]
},
"vendor": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_id": "<string>",
"individual_name": "<string>",
"company_name": "<string>",
"email": "<string>",
"mobile_phone": "<string>",
"office_phone": "<string>",
"address_string": "<string>",
"notes": "<string>",
"status": "ACTIVE",
"transaction_tags": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"key": "ExampleTagKey",
"value": "ExampleTagValue",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
]
},
"line_items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_id": "<string>",
"memo": "<string>",
"line_item_id": "<string>"
}
],
"entry": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ledger_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent": "SMS",
"entry_type": "BANK",
"date": "2023-11-07T05:31:56Z",
"entry_at": "2023-11-07T05:31:56Z",
"reversal_of_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reversal_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"line_items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account": {
"id": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"name": "Current Assets",
"stable_name": {
"type": "StableName",
"stable_name": "CURRENT_ASSETS"
},
"normality": "CREDIT",
"account_type": {
"value": "ASSET",
"display_name": "Asset"
},
"account_subtype": {
"value": "CURRENT",
"display_name": "Current Assets"
}
},
"amount": 123,
"direction": "CREDIT",
"entry_at": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z"
}
]
},
"transaction_tags": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"key": "ExampleTagKey",
"value": "ExampleTagValue",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
]
}