Create Checks

Create Checks

curl --request POST \
  --url https://test.onlinecheckwriter.com/api/v3/checks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "checks": [
    {
      "bankAccountId": "6gYVewBOP7Gdx7b",
      "payeeId": "ijKVewBOP7GdyhG",
      "categoryId": "",
      "serialNumber": "1001",
      "issueDate": "2020-10-25",
      "amount": 100,
      "memo": "First, Test check using API",
      "note": "",
      "accountNumber": "458756",
      "invoiceNumber": "2545",
      "noSign": false,
      "noAmount": false,
      "noDate": false,
      "noPayee": false,
      "voucherId": null,
      "customElements": {
        "element1": "first class tracking",
        "element2": "test sender"
      }
    }
  ]
}
'

{
  "success": true,
  "message": "Successfully created",
  "data": {
    "checks": [
      {
        "checkId": "<string>",
        "serialNumber": "<string>",
        "amount": "<string>",
        "status": 123,
        "bankAccount": {
          "bankAccountId": "<string>",
          "name": "<string>"
        },
        "payee": {
          "payeeId": "<string>",
          "name": "<string>"
        }
      }
    ]
  }
}

POST

checks

Create Checks

curl --request POST \
  --url https://test.onlinecheckwriter.com/api/v3/checks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "checks": [
    {
      "bankAccountId": "6gYVewBOP7Gdx7b",
      "payeeId": "ijKVewBOP7GdyhG",
      "categoryId": "",
      "serialNumber": "1001",
      "issueDate": "2020-10-25",
      "amount": 100,
      "memo": "First, Test check using API",
      "note": "",
      "accountNumber": "458756",
      "invoiceNumber": "2545",
      "noSign": false,
      "noAmount": false,
      "noDate": false,
      "noPayee": false,
      "voucherId": null,
      "customElements": {
        "element1": "first class tracking",
        "element2": "test sender"
      }
    }
  ]
}
'

{
  "success": true,
  "message": "Successfully created",
  "data": {
    "checks": [
      {
        "checkId": "<string>",
        "serialNumber": "<string>",
        "amount": "<string>",
        "status": 123,
        "bankAccount": {
          "bankAccountId": "<string>",
          "name": "<string>"
        },
        "payee": {
          "payeeId": "<string>",
          "name": "<string>"
        }
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Payload to create one or more checks.

checks

object[]

Show child attributes

checks.bankAccountId

string

required

Must be a valid bank account ID.

checks.payeeId

string

Must be a valid payee ID. Optional if noPayee is true.

checks.categoryId

string | null

Category ID, if applicable.

checks.serialNumber

string

Custom serial number for the check.

checks.issueDate

string<date>

Issue date of the check.

checks.amount

number

Amount of the check. Required unless noAmount is true.

checks.memo

string

Memo for the check.

checks.note

string

Internal note for the check.

checks.accountNumber

string

Account number associated with the check.

checks.invoiceNumber

string

Invoice number associated with the check.

checks.noSign

boolean

If true, creates the check without a signature. Defaults to false.

checks.noAmount

boolean

If true, creates the check without an amount. Defaults to false.

checks.noDate

boolean

If true, creates the check without a date. Defaults to false.

checks.noPayee

boolean

If true, creates the check without a payee. Defaults to false.

checks.voucherId

string | null

Voucher ID, if applicable. Ignored if voucher is passed.

checks.voucher

object

Show child attributes

checks.voucher.voucherNumber

string

Voucher number.

checks.voucher.memo

string

Memo associated with the voucher.

checks.voucher.date

string<date>

Voucher date.

checks.voucher.voucherItems

object[]

Show child attributes

checks.voucher.voucherItems.invoiceNumber

string

Invoice number associated with the voucher item.

checks.voucher.voucherItems.name

string

Name of the voucher item.

checks.voucher.voucherItems.description

string

Description of the voucher item.

checks.voucher.voucherItems.quantity

number | null

Quantity of the voucher item.

checks.voucher.voucherItems.unitCost

number | null

Unit cost of the voucher item.

checks.voucher.voucherItems.total

number

Total amount for the voucher item.

checks.customElements

object

Key-value pairs for custom elements.

Show child attributes

checks.customElements.{key}

string

Response

Check(s) created successfully.

success

boolean

Example:

true

message

string

Example:

"Successfully created"

data

object

Show child attributes

data.checks

object[]

Show child attributes

data.checks.checkId

string

data.checks.serialNumber

string

data.checks.amount

string

data.checks.status

number

data.checks.bankAccount

object

Show child attributes

data.checks.bankAccount.bankAccountId

string

data.checks.bankAccount.name

string

data.checks.payee

object

Show child attributes

data.checks.payee.payeeId

string

data.checks.payee.name

string

Get Check Update Check

⌘I

Get Started

Bank Account

Payee

Check

Mail Check

Authorizations

Body

Response