The Process Statement Of Accounts object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

frequency string
company string required
from_date string
to_date string
customer_collection string
collection_name string
account string
finance_book string
orientation string
start_date string
currency string
include_ageing boolean

Default: false

ageing_based_on string

Default: Due Date

enable_auto_email boolean

Default: false

primary_mandatory boolean

Default: true

filter_duration integer

Default: 1

subject string
body string
letter_head string
terms_and_conditions string
include_break boolean

Default: true

show_net_values_in_party_account boolean

Default: false

sender string
report string required
posting_date string
payment_terms_template string
sales_partner string
sales_person string
territory string
based_on_payment_terms boolean

Default: false

pdf_name string
ignore_exchange_rate_revaluation_journals boolean

Default: false

ignore_cr_dr_notes boolean

Default: false

show_remarks boolean

Default: false

categorize_by string

Default: Categorize by Voucher (Consolidated)

show_future_payments boolean

Default: false

print_format string
The Process Statement Of Accounts object 
{
  "id": "process-statement-of-accounts_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "frequency": "frequency_example",
  "company": "Example Corp",
  "from_date": "2024-01-15",
  "to_date": "2024-01-15",
  "customer_collection": "customer_collection_example",
  "collection_name": "collection_name_example",
  "account": "account_example",
  "finance_book": "finance_book_example",
  "orientation": "orientation_example",
  "start_date": "2024-01-15",
  "currency": "USD",
  "include_ageing": false,
  "ageing_based_on": "Due Date",
  "enable_auto_email": false,
  "primary_mandatory": true,
  "filter_duration": 1,
  "subject": "subject_example",
  "body": "body_example",
  "letter_head": "letter_head_example",
  "terms_and_conditions": "terms_and_conditions_example",
  "include_break": true,
  "show_net_values_in_party_account": false,
  "sender": "sender_example",
  "report": "report_example",
  "posting_date": "2024-01-15",
  "payment_terms_template": "payment_terms_template_example",
  "sales_partner": "sales_partner_example",
  "sales_person": "sales_person_example",
  "territory": "territory_example",
  "based_on_payment_terms": false,
  "pdf_name": "pdf_name_example",
  "ignore_exchange_rate_revaluation_journals": false,
  "ignore_cr_dr_notes": false,
  "show_remarks": false,
  "categorize_by": "Categorize by Voucher (Consolidated)",
  "show_future_payments": false,
  "print_format": "print_format_example"
}
GET /api/accounts/process-statement-of-accounts/{id}

Retrieve a process statement of accounts

Retrieves the details of an existing process statement of accounts. Supply the unique process statement of accounts ID that was returned from a previous request.

Path parameters

id string required

The identifier of the process statement of accounts to retrieve.

Returns

Returns the process statement of accounts object if a valid identifier was provided.

GET /api/accounts/process-statement-of-accounts/{id} 
curl https://api.overplane.dev/api/accounts/process-statement-of-accounts/process-statement-of-accounts_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "process-statement-of-accounts_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "frequency": "frequency_example",
  "company": "Example Corp",
  "from_date": "2024-01-15",
  "to_date": "2024-01-15",
  "customer_collection": "customer_collection_example",
  "collection_name": "collection_name_example",
  "account": "account_example",
  "finance_book": "finance_book_example",
  "orientation": "orientation_example",
  "start_date": "2024-01-15",
  "currency": "USD",
  "include_ageing": false,
  "ageing_based_on": "Due Date",
  "enable_auto_email": false,
  "primary_mandatory": true,
  "filter_duration": 1,
  "subject": "subject_example",
  "body": "body_example",
  "letter_head": "letter_head_example",
  "terms_and_conditions": "terms_and_conditions_example",
  "include_break": true,
  "show_net_values_in_party_account": false,
  "sender": "sender_example",
  "report": "report_example",
  "posting_date": "2024-01-15",
  "payment_terms_template": "payment_terms_template_example",
  "sales_partner": "sales_partner_example",
  "sales_person": "sales_person_example",
  "territory": "territory_example",
  "based_on_payment_terms": false,
  "pdf_name": "pdf_name_example",
  "ignore_exchange_rate_revaluation_journals": false,
  "ignore_cr_dr_notes": false,
  "show_remarks": false,
  "categorize_by": "Categorize by Voucher (Consolidated)",
  "show_future_payments": false,
  "print_format": "print_format_example"
}
GET /api/accounts/process-statement-of-accounts

List all process statement of accountss

Returns a list of process statement of accountss. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of process statement of accounts objects.

GET /api/accounts/process-statement-of-accounts 
curl https://api.overplane.dev/api/accounts/process-statement-of-accounts \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "process-statement-of-accounts_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "frequency": "frequency_example",
      "company": "Example Corp",
      "from_date": "2024-01-15",
      "to_date": "2024-01-15",
      "customer_collection": "customer_collection_example",
      "collection_name": "collection_name_example",
      "account": "account_example",
      "finance_book": "finance_book_example",
      "orientation": "orientation_example",
      "start_date": "2024-01-15",
      "currency": "USD",
      "include_ageing": false,
      "ageing_based_on": "Due Date",
      "enable_auto_email": false,
      "primary_mandatory": true,
      "filter_duration": 1,
      "subject": "subject_example",
      "body": "body_example",
      "letter_head": "letter_head_example",
      "terms_and_conditions": "terms_and_conditions_example",
      "include_break": true,
      "show_net_values_in_party_account": false,
      "sender": "sender_example",
      "report": "report_example",
      "posting_date": "2024-01-15",
      "payment_terms_template": "payment_terms_template_example",
      "sales_partner": "sales_partner_example",
      "sales_person": "sales_person_example",
      "territory": "territory_example",
      "based_on_payment_terms": false,
      "pdf_name": "pdf_name_example",
      "ignore_exchange_rate_revaluation_journals": false,
      "ignore_cr_dr_notes": false,
      "show_remarks": false,
      "categorize_by": "Categorize by Voucher (Consolidated)",
      "show_future_payments": false,
      "print_format": "print_format_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/process-statement-of-accounts

Create a process statement of accounts

Creates a new process statement of accounts object.

Body parameters

frequency string
company string required
from_date string
to_date string
customer_collection string
collection_name string
account string
finance_book string
orientation string
start_date string
currency string
include_ageing boolean

Default: false

ageing_based_on string

Default: Due Date

enable_auto_email boolean

Default: false

primary_mandatory boolean

Default: true

filter_duration integer

Default: 1

subject string
body string
letter_head string
terms_and_conditions string
include_break boolean

Default: true

show_net_values_in_party_account boolean

Default: false

sender string
report string required
posting_date string
payment_terms_template string
sales_partner string
sales_person string
territory string
based_on_payment_terms boolean

Default: false

pdf_name string
ignore_exchange_rate_revaluation_journals boolean

Default: false

ignore_cr_dr_notes boolean

Default: false

show_remarks boolean

Default: false

categorize_by string

Default: Categorize by Voucher (Consolidated)

show_future_payments boolean

Default: false

print_format string

Returns

Returns the newly created process statement of accounts object if the call succeeded.

POST /api/accounts/process-statement-of-accounts 
curl https://api.overplane.dev/api/accounts/process-statement-of-accounts \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"company":"Example Corp","report":"report_example"}'
Response 
{
  "id": "process-statement-of-accounts_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "frequency": "frequency_example",
  "company": "Example Corp",
  "from_date": "2024-01-15",
  "to_date": "2024-01-15",
  "customer_collection": "customer_collection_example",
  "collection_name": "collection_name_example",
  "account": "account_example",
  "finance_book": "finance_book_example",
  "orientation": "orientation_example",
  "start_date": "2024-01-15",
  "currency": "USD",
  "include_ageing": false,
  "ageing_based_on": "Due Date",
  "enable_auto_email": false,
  "primary_mandatory": true,
  "filter_duration": 1,
  "subject": "subject_example",
  "body": "body_example",
  "letter_head": "letter_head_example",
  "terms_and_conditions": "terms_and_conditions_example",
  "include_break": true,
  "show_net_values_in_party_account": false,
  "sender": "sender_example",
  "report": "report_example",
  "posting_date": "2024-01-15",
  "payment_terms_template": "payment_terms_template_example",
  "sales_partner": "sales_partner_example",
  "sales_person": "sales_person_example",
  "territory": "territory_example",
  "based_on_payment_terms": false,
  "pdf_name": "pdf_name_example",
  "ignore_exchange_rate_revaluation_journals": false,
  "ignore_cr_dr_notes": false,
  "show_remarks": false,
  "categorize_by": "Categorize by Voucher (Consolidated)",
  "show_future_payments": false,
  "print_format": "print_format_example"
}
PATCH /api/accounts/process-statement-of-accounts/{id}

Update a process statement of accounts

Updates the specified process statement of accounts by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the process statement of accounts to update.

Body parameters

frequency string
company string
from_date string
to_date string
customer_collection string
collection_name string
account string
finance_book string
orientation string
start_date string
currency string
include_ageing boolean

Default: false

ageing_based_on string

Default: Due Date

enable_auto_email boolean

Default: false

primary_mandatory boolean

Default: true

filter_duration integer

Default: 1

subject string
body string
letter_head string
terms_and_conditions string
include_break boolean

Default: true

show_net_values_in_party_account boolean

Default: false

sender string
report string
posting_date string
payment_terms_template string
sales_partner string
sales_person string
territory string
based_on_payment_terms boolean

Default: false

pdf_name string
ignore_exchange_rate_revaluation_journals boolean

Default: false

ignore_cr_dr_notes boolean

Default: false

show_remarks boolean

Default: false

categorize_by string

Default: Categorize by Voucher (Consolidated)

show_future_payments boolean

Default: false

print_format string

Returns

Returns the updated process statement of accounts object.

PATCH /api/accounts/process-statement-of-accounts/{id} 
curl https://api.overplane.dev/api/accounts/process-statement-of-accounts/process-statement-of-accounts_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"frequency":"frequency_example","company":"Example Corp"}'
Response 
{
  "id": "process-statement-of-accounts_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "frequency": "frequency_example",
  "company": "Example Corp",
  "from_date": "2024-01-15",
  "to_date": "2024-01-15",
  "customer_collection": "customer_collection_example",
  "collection_name": "collection_name_example",
  "account": "account_example",
  "finance_book": "finance_book_example",
  "orientation": "orientation_example",
  "start_date": "2024-01-15",
  "currency": "USD",
  "include_ageing": false,
  "ageing_based_on": "Due Date",
  "enable_auto_email": false,
  "primary_mandatory": true,
  "filter_duration": 1,
  "subject": "subject_example",
  "body": "body_example",
  "letter_head": "letter_head_example",
  "terms_and_conditions": "terms_and_conditions_example",
  "include_break": true,
  "show_net_values_in_party_account": false,
  "sender": "sender_example",
  "report": "report_example",
  "posting_date": "2024-01-15",
  "payment_terms_template": "payment_terms_template_example",
  "sales_partner": "sales_partner_example",
  "sales_person": "sales_person_example",
  "territory": "territory_example",
  "based_on_payment_terms": false,
  "pdf_name": "pdf_name_example",
  "ignore_exchange_rate_revaluation_journals": false,
  "ignore_cr_dr_notes": false,
  "show_remarks": false,
  "categorize_by": "Categorize by Voucher (Consolidated)",
  "show_future_payments": false,
  "print_format": "print_format_example"
}
DELETE /api/accounts/process-statement-of-accounts/{id}

Delete a process statement of accounts

Permanently deletes a process statement of accounts. This cannot be undone.

Path parameters

id string required

The identifier of the process statement of accounts to delete.

Returns

Returns a confirmation that the process statement of accounts has been deleted.

DELETE /api/accounts/process-statement-of-accounts/{id} 
curl https://api.overplane.dev/api/accounts/process-statement-of-accounts/process-statement-of-accounts_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "process-statement-of-accounts_abc123",
  "deleted": true
}

Line items

Child objects that belong to this process statement of accounts. These are accessed via the parent's ID.

Process Statement Of Accounts CC

Attributes

idx integer
process_statement_of_accounts_id string required
cc string

Endpoints

GET /api/accounts/process-statement-of-accounts-c-c?parent_id={id}
POST /api/accounts/process-statement-of-accounts-c-c
PATCH /api/accounts/process-statement-of-accounts-c-c/{id}
DELETE /api/accounts/process-statement-of-accounts-c-c/{id}
POST /api/accounts/process-statement-of-accounts-c-c/reorder
Process Statement Of Accounts CC object 
{
  "id": "process-statement-of-accounts-c-c_abc123",
  "idx": 1,
  "process_statement_of_accounts_id": "process_statement_of_accounts_id_example",
  "cc": "cc_example"
}

Process Statement Of Accounts Customer

Attributes

idx integer
process_statement_of_accounts_id string required
customer string required
primary_email string
billing_email string
customer_name string

Endpoints

GET /api/accounts/process-statement-of-accounts-customer?parent_id={id}
POST /api/accounts/process-statement-of-accounts-customer
PATCH /api/accounts/process-statement-of-accounts-customer/{id}
DELETE /api/accounts/process-statement-of-accounts-customer/{id}
POST /api/accounts/process-statement-of-accounts-customer/reorder
Process Statement Of Accounts Customer object 
{
  "id": "process-statement-of-accounts-customer_abc123",
  "idx": 1,
  "process_statement_of_accounts_id": "process_statement_of_accounts_id_example",
  "customer": "customer_example",
  "primary_email": "user@example.com",
  "billing_email": "user@example.com",
  "customer_name": "customer_name_example"
}

PSOA Cost Center

Attributes

idx integer
process_statement_of_accounts_id string required
cost_center_name string required

Endpoints

GET /api/accounts/p-s-o-a-cost-center?parent_id={id}
POST /api/accounts/p-s-o-a-cost-center
PATCH /api/accounts/p-s-o-a-cost-center/{id}
DELETE /api/accounts/p-s-o-a-cost-center/{id}
POST /api/accounts/p-s-o-a-cost-center/reorder
PSOA Cost Center object 
{
  "id": "p-s-o-a-cost-center_abc123",
  "idx": 1,
  "process_statement_of_accounts_id": "process_statement_of_accounts_id_example",
  "cost_center_name": "cost_center_name_example"
}

PSOA Project

Attributes

idx integer
process_statement_of_accounts_id string required
project_name string

Endpoints

GET /api/accounts/p-s-o-a-project?parent_id={id}
POST /api/accounts/p-s-o-a-project
PATCH /api/accounts/p-s-o-a-project/{id}
DELETE /api/accounts/p-s-o-a-project/{id}
POST /api/accounts/p-s-o-a-project/reorder
PSOA Project object 
{
  "id": "p-s-o-a-project_abc123",
  "idx": 1,
  "process_statement_of_accounts_id": "process_statement_of_accounts_id_example",
  "project_name": "project_name_example"
}