Skip to main content
POST
/
api
/
banking
/
matching
/
match
Match the given uncategorized transaction.
curl --request POST \
  --url https://api.example.com/api/banking/matching/match \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'organization-id: <organization-id>' \
  --data '
{
  "uncategorizedTransactions": [
    1,
    2
  ],
  "matchedTransactions": [
    {
      "referenceType": "SaleInvoice",
      "referenceId": 1
    },
    {
      "referenceType": "SaleInvoice",
      "referenceId": 2
    }
  ]
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.bigcapital.app/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
Authorization
string
required

Value must be 'Bearer ' where is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

​
organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

Body

application/json
​
uncategorizedTransactions
number[]
required

Uncategorized transaction IDs to match

Example:
[1, 2]
​
matchedTransactions
string[]
required

The entries to match

Example:
[
  {
    "referenceType": "SaleInvoice",
    "referenceId": 1
  },
  {
    "referenceType": "SaleInvoice",
    "referenceId": 2
  }
]

Response

201 - undefined