Create accounting account
You can create an accounting account on the Pismo platform, so you can add it to your accounting script. In the accounting script, you set an accounting account as a debit and another accounting account as a credit. When you run the accounting script, the Pismo platform creates an accounting entry using the accounting account’s information.
Create an accounting account
To create an accounting account:
- Go to Create accounting account.
- Enter the description of this account in the description field.
- Enter the account number in the account field.
- Enter your program ID in the program_id field.
- Run the endpoint.
The response shows when you created the accounting account in the created_at
field.
Example
This response shows a created accounting account.
{
"id": 1,
"description": "SAMPLE ACCOUNT",
"account": "123123132-x",
"program_id": 12,
"created_at": "2021-10-10T10:10:00.000Z"
}
Search for an accounting account
There are two ways you can search for an accounting account on the Pismo platform. You can either search for an account by its ID or search for all accounts. To search by ID, copy the id
number from a created accounting account and paste it into the accountingAccountId field.
Example
This response shows when you search a list of accounting accounts:
{
"has_next": false,
"items": [
{
"id": 1,
"description": "ACCOUNTING ACCOUNT CREATION TEST",
"account": "123123132-x",
"program_id": 1,
"created_at": "2021-07-22T00:37:20Z"
},
{
"id": 2,
"description": "ACCOUNTING ACCOUNT CREATION TEST",
"account": "123123132-x",
"program_id": 1,
"created_at": "2021-07-22T00:37:20Z"
}
]
}
The
has_next
parameter means there are more pages to view.
You can still search for deactivated accounting accounts. This response shows a deactivated accounting account. The deactivated_at
field only returns when the account is deactivated.
{
"has_next": false,
"items": [
{
"id": 1,
"description": "ACCOUNTING ACCOUNT CREATION TEST",
"account": "123123132-x",
"program_id": 1,
"created_at": "2021-07-22T00:37:20Z",
"deactivated_at": "2021-07-23T00:37:20Z"
}
]
}
Update an accounting account description
If you find an accounting account description that’s incorrect, you can update it. To update a description of an accounting account:
- Use the account ID from either
credit_accounting
ordebit_accounting
fields in the response of the accounting script. - Paste this number into the accountingAccountId field of the Update an accounting account description by ID endpoint.
- Write the new description for the accounting account in the
description
body parameter. - Run the endpoint.
Example
This response shows the accounting account description before an update.
{
"id": 2,
"description": "THIS IS THE OLD DESCRIPTION",
"account": "123123132-x",
"program_id": 1,
"created_at": "2021-07-22T00:37:20Z"
}
This response shows the accounting account description after an update.
{
"id": 2,
"description": "THIS IS THE NEW DESCRIPTION",
"account": "123123132-x",
"program_id": 1,
"created_at": "2021-07-22T00:37:20Z"
}
Deactivate an accounting account
To deactivate an accounting account, paste the ID into the accountingAccountId field of the Deactivated an accounting account by ID endpoint. To paste this ID, copy the number from the id
field in an accounting account. The response shows when you deactivated the accounting account in the deactivated_at
field.
Example
This response shows a deactivated accounting account.
{
"id": 10,
"description": "ACCOUNTINGACCOUNT",
"account": "123123132-T1",
"program_id": 1,
"created_at": "2022-06-27T18:01:42Z",
"deactivated_at": "2022-06-28T14:30:58.350214-03:00"
}
Updated 10 months ago