The Cheque Print Template 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.

has_print_format boolean

Default: false

bank_name string required
cheque_size string

Default: Regular

starting_position_from_top_edge number
cheque_width number

Default: 20

cheque_height number

Default: 9

scanned_cheque string
is_account_payable boolean

Default: true

acc_pay_dist_from_top_edge number

Default: 1

acc_pay_dist_from_left_edge number

Default: 9

message_to_show string

Default: Acc. Payee

date_dist_from_top_edge number

Default: 1

date_dist_from_left_edge number

Default: 15

payer_name_from_top_edge number

Default: 2

payer_name_from_left_edge number

Default: 3

amt_in_words_from_top_edge number

Default: 3

amt_in_words_from_left_edge number

Default: 4

amt_in_word_width number

Default: 15

amt_in_words_line_spacing number

Default: 0.5

amt_in_figures_from_top_edge number

Default: 3.5

amt_in_figures_from_left_edge number

Default: 16

acc_no_dist_from_top_edge number

Default: 5

acc_no_dist_from_left_edge number

Default: 4

signatory_from_top_edge number

Default: 6

signatory_from_left_edge number

Default: 15

The Cheque Print Template object 
{
  "id": "cheque-print-template_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "has_print_format": false,
  "bank_name": "bank_name_example",
  "cheque_size": "Regular",
  "starting_position_from_top_edge": 0,
  "cheque_width": 20,
  "cheque_height": 9,
  "scanned_cheque": "scanned_cheque_example",
  "is_account_payable": true,
  "acc_pay_dist_from_top_edge": 1,
  "acc_pay_dist_from_left_edge": 9,
  "message_to_show": "Acc. Payee",
  "date_dist_from_top_edge": 1,
  "date_dist_from_left_edge": 15,
  "payer_name_from_top_edge": 2,
  "payer_name_from_left_edge": 3,
  "amt_in_words_from_top_edge": 3,
  "amt_in_words_from_left_edge": 4,
  "amt_in_word_width": 15,
  "amt_in_words_line_spacing": 0.5,
  "amt_in_figures_from_top_edge": 3.5,
  "amt_in_figures_from_left_edge": 16,
  "acc_no_dist_from_top_edge": 5,
  "acc_no_dist_from_left_edge": 4,
  "signatory_from_top_edge": 6,
  "signatory_from_left_edge": 15
}
GET /api/accounts/cheque-print-template/{id}

Retrieve a cheque print template

Retrieves the details of an existing cheque print template. Supply the unique cheque print template ID that was returned from a previous request.

Path parameters

id string required

The identifier of the cheque print template to retrieve.

Returns

Returns the cheque print template object if a valid identifier was provided.

GET /api/accounts/cheque-print-template/{id} 
curl https://api.overplane.dev/api/accounts/cheque-print-template/cheque-print-template_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "cheque-print-template_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "has_print_format": false,
  "bank_name": "bank_name_example",
  "cheque_size": "Regular",
  "starting_position_from_top_edge": 0,
  "cheque_width": 20,
  "cheque_height": 9,
  "scanned_cheque": "scanned_cheque_example",
  "is_account_payable": true,
  "acc_pay_dist_from_top_edge": 1,
  "acc_pay_dist_from_left_edge": 9,
  "message_to_show": "Acc. Payee",
  "date_dist_from_top_edge": 1,
  "date_dist_from_left_edge": 15,
  "payer_name_from_top_edge": 2,
  "payer_name_from_left_edge": 3,
  "amt_in_words_from_top_edge": 3,
  "amt_in_words_from_left_edge": 4,
  "amt_in_word_width": 15,
  "amt_in_words_line_spacing": 0.5,
  "amt_in_figures_from_top_edge": 3.5,
  "amt_in_figures_from_left_edge": 16,
  "acc_no_dist_from_top_edge": 5,
  "acc_no_dist_from_left_edge": 4,
  "signatory_from_top_edge": 6,
  "signatory_from_left_edge": 15
}
GET /api/accounts/cheque-print-template

List all cheque print templates

Returns a list of cheque print templates. 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 cheque print template objects.

GET /api/accounts/cheque-print-template 
curl https://api.overplane.dev/api/accounts/cheque-print-template \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "cheque-print-template_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "has_print_format": false,
      "bank_name": "bank_name_example",
      "cheque_size": "Regular",
      "starting_position_from_top_edge": 0,
      "cheque_width": 20,
      "cheque_height": 9,
      "scanned_cheque": "scanned_cheque_example",
      "is_account_payable": true,
      "acc_pay_dist_from_top_edge": 1,
      "acc_pay_dist_from_left_edge": 9,
      "message_to_show": "Acc. Payee",
      "date_dist_from_top_edge": 1,
      "date_dist_from_left_edge": 15,
      "payer_name_from_top_edge": 2,
      "payer_name_from_left_edge": 3,
      "amt_in_words_from_top_edge": 3,
      "amt_in_words_from_left_edge": 4,
      "amt_in_word_width": 15,
      "amt_in_words_line_spacing": 0.5,
      "amt_in_figures_from_top_edge": 3.5,
      "amt_in_figures_from_left_edge": 16,
      "acc_no_dist_from_top_edge": 5,
      "acc_no_dist_from_left_edge": 4,
      "signatory_from_top_edge": 6,
      "signatory_from_left_edge": 15
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/cheque-print-template

Create a cheque print template

Creates a new cheque print template object.

Body parameters

has_print_format boolean

Default: false

bank_name string required
cheque_size string

Default: Regular

starting_position_from_top_edge number
cheque_width number

Default: 20

cheque_height number

Default: 9

scanned_cheque string
is_account_payable boolean

Default: true

acc_pay_dist_from_top_edge number

Default: 1

acc_pay_dist_from_left_edge number

Default: 9

message_to_show string

Default: Acc. Payee

date_dist_from_top_edge number

Default: 1

date_dist_from_left_edge number

Default: 15

payer_name_from_top_edge number

Default: 2

payer_name_from_left_edge number

Default: 3

amt_in_words_from_top_edge number

Default: 3

amt_in_words_from_left_edge number

Default: 4

amt_in_word_width number

Default: 15

amt_in_words_line_spacing number

Default: 0.5

amt_in_figures_from_top_edge number

Default: 3.5

amt_in_figures_from_left_edge number

Default: 16

acc_no_dist_from_top_edge number

Default: 5

acc_no_dist_from_left_edge number

Default: 4

signatory_from_top_edge number

Default: 6

signatory_from_left_edge number

Default: 15

Returns

Returns the newly created cheque print template object if the call succeeded.

POST /api/accounts/cheque-print-template 
curl https://api.overplane.dev/api/accounts/cheque-print-template \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"bank_name":"bank_name_example"}'
Response 
{
  "id": "cheque-print-template_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "has_print_format": false,
  "bank_name": "bank_name_example",
  "cheque_size": "Regular",
  "starting_position_from_top_edge": 0,
  "cheque_width": 20,
  "cheque_height": 9,
  "scanned_cheque": "scanned_cheque_example",
  "is_account_payable": true,
  "acc_pay_dist_from_top_edge": 1,
  "acc_pay_dist_from_left_edge": 9,
  "message_to_show": "Acc. Payee",
  "date_dist_from_top_edge": 1,
  "date_dist_from_left_edge": 15,
  "payer_name_from_top_edge": 2,
  "payer_name_from_left_edge": 3,
  "amt_in_words_from_top_edge": 3,
  "amt_in_words_from_left_edge": 4,
  "amt_in_word_width": 15,
  "amt_in_words_line_spacing": 0.5,
  "amt_in_figures_from_top_edge": 3.5,
  "amt_in_figures_from_left_edge": 16,
  "acc_no_dist_from_top_edge": 5,
  "acc_no_dist_from_left_edge": 4,
  "signatory_from_top_edge": 6,
  "signatory_from_left_edge": 15
}
PATCH /api/accounts/cheque-print-template/{id}

Update a cheque print template

Updates the specified cheque print template 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 cheque print template to update.

Body parameters

has_print_format boolean

Default: false

bank_name string
cheque_size string

Default: Regular

starting_position_from_top_edge number
cheque_width number

Default: 20

cheque_height number

Default: 9

scanned_cheque string
is_account_payable boolean

Default: true

acc_pay_dist_from_top_edge number

Default: 1

acc_pay_dist_from_left_edge number

Default: 9

message_to_show string

Default: Acc. Payee

date_dist_from_top_edge number

Default: 1

date_dist_from_left_edge number

Default: 15

payer_name_from_top_edge number

Default: 2

payer_name_from_left_edge number

Default: 3

amt_in_words_from_top_edge number

Default: 3

amt_in_words_from_left_edge number

Default: 4

amt_in_word_width number

Default: 15

amt_in_words_line_spacing number

Default: 0.5

amt_in_figures_from_top_edge number

Default: 3.5

amt_in_figures_from_left_edge number

Default: 16

acc_no_dist_from_top_edge number

Default: 5

acc_no_dist_from_left_edge number

Default: 4

signatory_from_top_edge number

Default: 6

signatory_from_left_edge number

Default: 15

Returns

Returns the updated cheque print template object.

PATCH /api/accounts/cheque-print-template/{id} 
curl https://api.overplane.dev/api/accounts/cheque-print-template/cheque-print-template_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"has_print_format":false,"bank_name":"bank_name_example"}'
Response 
{
  "id": "cheque-print-template_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "has_print_format": false,
  "bank_name": "bank_name_example",
  "cheque_size": "Regular",
  "starting_position_from_top_edge": 0,
  "cheque_width": 20,
  "cheque_height": 9,
  "scanned_cheque": "scanned_cheque_example",
  "is_account_payable": true,
  "acc_pay_dist_from_top_edge": 1,
  "acc_pay_dist_from_left_edge": 9,
  "message_to_show": "Acc. Payee",
  "date_dist_from_top_edge": 1,
  "date_dist_from_left_edge": 15,
  "payer_name_from_top_edge": 2,
  "payer_name_from_left_edge": 3,
  "amt_in_words_from_top_edge": 3,
  "amt_in_words_from_left_edge": 4,
  "amt_in_word_width": 15,
  "amt_in_words_line_spacing": 0.5,
  "amt_in_figures_from_top_edge": 3.5,
  "amt_in_figures_from_left_edge": 16,
  "acc_no_dist_from_top_edge": 5,
  "acc_no_dist_from_left_edge": 4,
  "signatory_from_top_edge": 6,
  "signatory_from_left_edge": 15
}
DELETE /api/accounts/cheque-print-template/{id}

Delete a cheque print template

Permanently deletes a cheque print template. This cannot be undone.

Path parameters

id string required

The identifier of the cheque print template to delete.

Returns

Returns a confirmation that the cheque print template has been deleted.

DELETE /api/accounts/cheque-print-template/{id} 
curl https://api.overplane.dev/api/accounts/cheque-print-template/cheque-print-template_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "cheque-print-template_abc123",
  "deleted": true
}