The Bank Guarantee 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.

status string

Default: draft

bg_type string required

reference_doctype string

reference_docname string

customer string

supplier string

project string

amount number required

start_date string required

validity integer

end_date string

bank string

bank_account string

account string

bank_account_no string

iban string

branch_code string

swift_number string

more_information string

bank_guarantee_number string

name_of_beneficiary string

margin_money number

charges number

fixed_deposit_number string

The Bank Guarantee object

{
  "id": "bank-guarantee_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "bg_type": "bg_type_example",
  "reference_doctype": "reference_doctype_example",
  "reference_docname": "reference_docname_example",
  "customer": "customer_example",
  "supplier": "supplier_example",
  "project": "project_example",
  "amount": 0,
  "start_date": "2024-01-15",
  "validity": 0,
  "end_date": "2024-01-15",
  "bank": "bank_example",
  "bank_account": "bank_account_example",
  "account": "account_example",
  "bank_account_no": "bank_account_no_example",
  "iban": "iban_example",
  "branch_code": "branch_code_example",
  "swift_number": "swift_number_example",
  "more_information": "more_information_example",
  "bank_guarantee_number": "bank_guarantee_number_example",
  "name_of_beneficiary": "name_of_beneficiary_example",
  "margin_money": 0,
  "charges": 0,
  "fixed_deposit_number": "fixed_deposit_number_example"
}

GET /api/accounts/bank-guarantee/{id}

Retrieve a bank guarantee

Retrieves the details of an existing bank guarantee. Supply the unique bank guarantee ID that was returned from a previous request.

Path parameters

id string required

The identifier of the bank guarantee to retrieve.

Returns

Returns the bank guarantee object if a valid identifier was provided.

GET /api/accounts/bank-guarantee/{id}

curl https://api.overplane.dev/api/accounts/bank-guarantee/bank-guarantee_abc123 \
  -H "Authorization: Bearer sk_test_..."

Response

{
  "id": "bank-guarantee_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "bg_type": "bg_type_example",
  "reference_doctype": "reference_doctype_example",
  "reference_docname": "reference_docname_example",
  "customer": "customer_example",
  "supplier": "supplier_example",
  "project": "project_example",
  "amount": 0,
  "start_date": "2024-01-15",
  "validity": 0,
  "end_date": "2024-01-15",
  "bank": "bank_example",
  "bank_account": "bank_account_example",
  "account": "account_example",
  "bank_account_no": "bank_account_no_example",
  "iban": "iban_example",
  "branch_code": "branch_code_example",
  "swift_number": "swift_number_example",
  "more_information": "more_information_example",
  "bank_guarantee_number": "bank_guarantee_number_example",
  "name_of_beneficiary": "name_of_beneficiary_example",
  "margin_money": 0,
  "charges": 0,
  "fixed_deposit_number": "fixed_deposit_number_example"
}

GET /api/accounts/bank-guarantee

List all bank guarantees

Returns a list of bank guarantees. 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 bank guarantee objects.

GET /api/accounts/bank-guarantee

curl https://api.overplane.dev/api/accounts/bank-guarantee \
  -H "Authorization: Bearer sk_test_..."

Response

{
  "data": [
    {
      "id": "bank-guarantee_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "bg_type": "bg_type_example",
      "reference_doctype": "reference_doctype_example",
      "reference_docname": "reference_docname_example",
      "customer": "customer_example",
      "supplier": "supplier_example",
      "project": "project_example",
      "amount": 0,
      "start_date": "2024-01-15",
      "validity": 0,
      "end_date": "2024-01-15",
      "bank": "bank_example",
      "bank_account": "bank_account_example",
      "account": "account_example",
      "bank_account_no": "bank_account_no_example",
      "iban": "iban_example",
      "branch_code": "branch_code_example",
      "swift_number": "swift_number_example",
      "more_information": "more_information_example",
      "bank_guarantee_number": "bank_guarantee_number_example",
      "name_of_beneficiary": "name_of_beneficiary_example",
      "margin_money": 0,
      "charges": 0,
      "fixed_deposit_number": "fixed_deposit_number_example"
    }
  ],
  "has_more": false,
  "total": 1
}

POST /api/accounts/bank-guarantee

Create a bank guarantee

Creates a new bank guarantee object.

Body parameters

status string

Default: draft

bg_type string required

reference_doctype string

reference_docname string

customer string

supplier string

project string

amount number required

start_date string required

validity integer

end_date string

bank string

bank_account string

account string

bank_account_no string

iban string

branch_code string

swift_number string

more_information string

bank_guarantee_number string

name_of_beneficiary string

margin_money number

charges number

fixed_deposit_number string

Returns

Returns the newly created bank guarantee object if the call succeeded.

POST /api/accounts/bank-guarantee

curl https://api.overplane.dev/api/accounts/bank-guarantee \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"bg_type":"bg_type_example","amount":0,"start_date":"2024-01-15"}'

Response

{
  "id": "bank-guarantee_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "bg_type": "bg_type_example",
  "reference_doctype": "reference_doctype_example",
  "reference_docname": "reference_docname_example",
  "customer": "customer_example",
  "supplier": "supplier_example",
  "project": "project_example",
  "amount": 0,
  "start_date": "2024-01-15",
  "validity": 0,
  "end_date": "2024-01-15",
  "bank": "bank_example",
  "bank_account": "bank_account_example",
  "account": "account_example",
  "bank_account_no": "bank_account_no_example",
  "iban": "iban_example",
  "branch_code": "branch_code_example",
  "swift_number": "swift_number_example",
  "more_information": "more_information_example",
  "bank_guarantee_number": "bank_guarantee_number_example",
  "name_of_beneficiary": "name_of_beneficiary_example",
  "margin_money": 0,
  "charges": 0,
  "fixed_deposit_number": "fixed_deposit_number_example"
}

PATCH /api/accounts/bank-guarantee/{id}

Update a bank guarantee

Updates the specified bank guarantee 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 bank guarantee to update.

Body parameters

status string

Default: draft

bg_type string

reference_doctype string

reference_docname string

customer string

supplier string

project string

amount number

start_date string

validity integer

end_date string

bank string

bank_account string

account string

bank_account_no string

iban string

branch_code string

swift_number string

more_information string

bank_guarantee_number string

name_of_beneficiary string

margin_money number

charges number

fixed_deposit_number string

Returns

Returns the updated bank guarantee object.

PATCH /api/accounts/bank-guarantee/{id}

curl https://api.overplane.dev/api/accounts/bank-guarantee/bank-guarantee_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","bg_type":"bg_type_example"}'

Response

{
  "id": "bank-guarantee_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "bg_type": "bg_type_example",
  "reference_doctype": "reference_doctype_example",
  "reference_docname": "reference_docname_example",
  "customer": "customer_example",
  "supplier": "supplier_example",
  "project": "project_example",
  "amount": 0,
  "start_date": "2024-01-15",
  "validity": 0,
  "end_date": "2024-01-15",
  "bank": "bank_example",
  "bank_account": "bank_account_example",
  "account": "account_example",
  "bank_account_no": "bank_account_no_example",
  "iban": "iban_example",
  "branch_code": "branch_code_example",
  "swift_number": "swift_number_example",
  "more_information": "more_information_example",
  "bank_guarantee_number": "bank_guarantee_number_example",
  "name_of_beneficiary": "name_of_beneficiary_example",
  "margin_money": 0,
  "charges": 0,
  "fixed_deposit_number": "fixed_deposit_number_example"
}

DELETE /api/accounts/bank-guarantee/{id}

Delete a bank guarantee

Permanently deletes a bank guarantee. This cannot be undone.

Path parameters

id string required

The identifier of the bank guarantee to delete.

Returns

Returns a confirmation that the bank guarantee has been deleted.

DELETE /api/accounts/bank-guarantee/{id}

curl https://api.overplane.dev/api/accounts/bank-guarantee/bank-guarantee_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE

Response

{
  "id": "bank-guarantee_abc123",
  "deleted": true
}

POST /api/accounts/bank-guarantee/{id}/submit

Submit a bank guarantee

Submits a draft bank guarantee, transitioning its status from draft to submitted.

Path parameters

id string required

The identifier of the bank guarantee to act on.

Returns

Returns the bank guarantee object with updated status.

POST /api/accounts/bank-guarantee/{id}/submit

curl https://api.overplane.dev/api/accounts/bank-guarantee/bank-guarantee_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST

Response

{
  "id": "bank-guarantee_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "bg_type": "bg_type_example",
  "reference_doctype": "reference_doctype_example",
  "reference_docname": "reference_docname_example",
  "customer": "customer_example",
  "supplier": "supplier_example",
  "project": "project_example",
  "amount": 0,
  "start_date": "2024-01-15",
  "validity": 0,
  "end_date": "2024-01-15",
  "bank": "bank_example",
  "bank_account": "bank_account_example",
  "account": "account_example",
  "bank_account_no": "bank_account_no_example",
  "iban": "iban_example",
  "branch_code": "branch_code_example",
  "swift_number": "swift_number_example",
  "more_information": "more_information_example",
  "bank_guarantee_number": "bank_guarantee_number_example",
  "name_of_beneficiary": "name_of_beneficiary_example",
  "margin_money": 0,
  "charges": 0,
  "fixed_deposit_number": "fixed_deposit_number_example"
}

POST /api/accounts/bank-guarantee/{id}/cancel

Cancel a bank guarantee

Cancels a submitted bank guarantee, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the bank guarantee to act on.

Returns

Returns the bank guarantee object with updated status.

POST /api/accounts/bank-guarantee/{id}/cancel

curl https://api.overplane.dev/api/accounts/bank-guarantee/bank-guarantee_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST

Response

{
  "id": "bank-guarantee_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "bg_type": "bg_type_example",
  "reference_doctype": "reference_doctype_example",
  "reference_docname": "reference_docname_example",
  "customer": "customer_example",
  "supplier": "supplier_example",
  "project": "project_example",
  "amount": 0,
  "start_date": "2024-01-15",
  "validity": 0,
  "end_date": "2024-01-15",
  "bank": "bank_example",
  "bank_account": "bank_account_example",
  "account": "account_example",
  "bank_account_no": "bank_account_no_example",
  "iban": "iban_example",
  "branch_code": "branch_code_example",
  "swift_number": "swift_number_example",
  "more_information": "more_information_example",
  "bank_guarantee_number": "bank_guarantee_number_example",
  "name_of_beneficiary": "name_of_beneficiary_example",
  "margin_money": 0,
  "charges": 0,
  "fixed_deposit_number": "fixed_deposit_number_example"
}

The Bank Guarantee object

Attributes

Retrieve a bank guarantee

Path parameters

Returns

List all bank guarantees

Query parameters

Returns

Create a bank guarantee

Body parameters

Returns

Update a bank guarantee

Path parameters

Body parameters

Returns

Delete a bank guarantee

Path parameters

Returns

Submit a bank guarantee

Path parameters

Returns

Cancel a bank guarantee

Path parameters

Returns

Coming Soon