Sign in

v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB
Bank Accounts

Create a requisition

Creates a requisition against a trust account and supports the account approval workflow.

Whether the requisition requires approval depends on the trust account configuration:

  • If approvals are enabled, firm owners can create requisitions without approval, while all other users require approval.
  • If approvals are disabled, the requisition is automatically approved upon creation.
post/bankaccounts/{id}/requisitions

Path parameters

idstring required

Request body

matterIdstring required

Unique identifier of the associated matter. Required.

approverUserIdstring nullable

Approver user ID.

Cannot be the same user ID as the user making the requisition request. If provided, must be a valid user ID in the system.

Optional. If not provided, default approver will be used.

payorIdstring nullable

Unique identifier of the Payor/Contact ID. Required in US region only.

payeeIdstring required

Unique identifier of the person or organisation being paid. Required.

sourcestring required

Payment source. Required. Possible values:

  • "Bank Transfer" - always available
  • "Bank Check" - available in AU and UK only
  • "Trust Check" - available in AU and UK only
  • "Direct Debit" - available in AU and UK only
  • "Check" - available in US only
referencestring nullable

Payment reference.

amountnumber double required

The payment amount in dollars. Limited to 2 decimal places (cents).

effectiveDatestring date-time

Date of requisition.

accountNamestring nullable

Account name. Required when Source is an electronic payment ('Bank Transfer' or 'Direct Debit') and transfer is expected to be via Direct Deposit (provide AccountName, BSB, and AccountNumber).

bsbstring nullable

BSB (Bank State Branch). Required when Source is an electronic payment ('Bank Transfer' or 'Direct Debit') and transfer is expected to be via Direct Deposit (provide AccountName, BSB, and AccountNumber).

accountNumberstring nullable

Account number. Required when Source is an electronic payment ('Bank Transfer' or 'Direct Debit') and transfer is expected to be via Direct Deposit (provide AccountName, BSB, and AccountNumber).

organizationOrCompanyNamestring nullable

Organization or company name. Required when Source is an electronic payment ('Bank Transfer' or 'Direct Debit') and transfer is expected to be via BPAY (provide OrganizationOrCompanyName, BillerCode, and BillerReference).

billerCodestring nullable

Biller code. Required when Source is an electronic payment ('Bank Transfer' or 'Direct Debit') and transfer is expected to be via BPAY (provide OrganizationOrCompanyName, BillerCode, and BillerReference).

billerReferencestring nullable

Biller reference. Required when Source is an electronic payment ('Bank Transfer' or 'Direct Debit') and transfer is expected to be via BPAY (provide OrganizationOrCompanyName, BillerCode, and BillerReference).

reasonstring nullable

Reason for the payment. Free format string.

internalNotestring nullable

Internal note. Free format string.

Example request

{
  "matterId": "da4e7fd1-5394-4ca9-b1c6-e18c4e2bf262",
  "approverUserId": "18c05819-c321-4907-800c-d5a608729c5a",
  "payorId": "18c05819-c321-4907-800c-d5a608729c5a",
  "payeeId": "18c05819-c321-4907-800c-d5a608729c5a",
  "source": "Bank Transfer",
  "reference": "REF123456",
  "amount": 100.5,
  "accountName": "John Doe",
  "bsb": "123456",
  "accountNumber": "12345678",
  "organizationOrCompanyName": "ACME Corporation",
  "billerCode": "12345",
  "billerReference": "REF123456",
  "reason": "Payment for services rendered",
  "internalNote": "Internal note about this payment"
}

Response

When request is accepted. Returns requisition status and balances.

idstring nullable

Requisition ID if requisition requires approval.

statusstring

Status of the requisition (e.g., Pending, Approved).

protectedBalancenumber double

Protected balance after the requisition.

availableBalancenumber double

Available balance after the requisition.

totalBalancenumber double

Total balance after the requisition.

pdfPaymentDetailstring nullable

Link to the PDF payment detail document.

Example response

{
  "id": "18c05819-c321-4907-800c-d5a608729c5a",
  "status": "Approved",
  "protectedBalance": 1000,
  "availableBalance": 5000,
  "totalBalance": 6000
}