Kyriba
App · 25 actions
Work with Kyriba treasury data: bank accounts, cash and bank statement balances, cash flows, payment transfers and files, third parties and process templates, and start workflows when cash flows, payments or accounts change.
Actions
| Action | What it does |
|---|---|
| Create cash flow | Add a cash flow to an account: a forecast, or an actual or intraday movement. |
| Delete cash flow | Delete a cash flow for good. |
| Delete transfer | Delete a payment transfer that hasn't been validated or batched yet. |
| Get bank account | Get one account with its bank branch, account number, currency, statement settings and payment settings. |
| Get bank statement balance | Get the balance a bank reported for an account on a day, from its bank statements, with the day of the latest one. |
| Get cash balance | Get an account's cash balance for each day of a period, counting actuals and the forecasts you choose. |
| Get cash flow | Get one cash flow with its account, code, amount, dates and status. |
| Get company | Get one company with its address, currencies, legal details and contacts. |
| Get payment file log | Get a payment file's status and processing log, to see why it was rejected or where it is. |
| Get result file | Get the file a process template's task made, such as an export or report: its text, or its bytes in base64 for a PDF or spreadsheet. |
| Get task status | Get the status, times and log of a task a process template started. |
| Get third party | Get one third party with its address, contact, bank accounts and the companies that use it. |
| List bank accounts | List bank and intercompany accounts with their company, bank, currency, IBAN and status, filtered by company, currency, status or type. |
| List banks | List the banks set up in Kyriba, with their codes and countries. |
| List cash flow codes | List the cash flow codes that classify cash flows, such as incoming wires or supplier payments. |
| List cash flows | List cash flows (forecasts, actuals and intraday movements) in a date range, by account, cash flow code, status or reference. |
| List companies | List the companies (legal entities) set up in Kyriba, by name or country. |
| List currencies | List the currencies set up in Kyriba, with their decimals and which is the reference currency. |
| List payment files | List bulk payment files sent through Kyriba, with their status, next action and acknowledgements. |
| List process templates | List process templates: Kyriba's saved imports, exports, reports and processes. |
| List third parties | List third parties (suppliers, customers and other counterparties) by name or status. |
| List transfers | List payment transfers with their status, next action, batch and the bank's last acknowledgement, by file, transaction number, reference or batch. |
| List users | List Kyriba users with their access profile and when they last signed in, by email or last name. |
| Run process template | Start a process template, such as an export of bank actuals or a report. |
| Update cash flow | Change a cash flow's amount, currency, status, code, dates, description or reference. |
Create cash flow
Add a cash flow to an account: a forecast, or an actual or intraday movement. The cash flow code decides whether money comes in or goes out.
Inputs
- Bank account
accounttextRequired - The account. Pick one, or give its code or UUID.
- Cash flow code
flow_codetextRequired - The cash flow code. Pick one, or give its code or UUID.
- Amount
amountnumberRequired - The amount, such as 10580.12.
- Currency
currencytextRequired - The amount's currency, usually the account's.
- Status
statustext - Estimated or confirmed for a forecast, actual or intraday for a movement. Defaults to confirmed.One of:
ESTIMATED(Estimated (forecast)),CONFIRMED(Confirmed (forecast)),ACTUAL,INTRADAY. - Transaction date
transaction_datedate - The transaction date. Defaults to today.
- Value date
value_datedate - The value date. Defaults to today.
- Accounting date
accounting_datedate - The accounting date. Defaults to today.
- Budget code
budget_codetext - The budget code. Kyriba uses the cash flow code's own when left empty.
- Description
descriptiontext - A description, up to 2,500 characters.
- Reference
referencetext - A reference, up to 250 characters.
Outputs
cash_flow_idtext- The new cash flow's UUID
createdtrue/false- Always true once created
Example output
{
"cash_flow_id": "a300ec56-7e3d-4c14-935f-a0fe25bef270",
"created": true
}Delete cash flow
Delete a cash flow for good. Kyriba advises moving a cash flow to a dedicated cash flow code instead when its history matters.
Inputs
- Cash flow UUID
cash_flow_idtextRequired - The cash flow's UUID, from 'List cash flows' or 'Create cash flow'.
Outputs
cash_flow_idtext- The deleted cash flow's UUID
deletedtrue/false- Always true once deleted
Example output
{
"cash_flow_id": "a300ec56-7e3d-4c14-935f-a0fe25bef270",
"deleted": true
}Delete transfer
Delete a payment transfer that hasn't been validated or batched yet. Kyriba refuses one that has.
Inputs
- Transfer
transfertextRequired - The transfer's UUID or transaction number, from 'List transfers'.
Outputs
deletedtrue/false- Always true once deleted
transfertext- The transfer deleted
Example output
{
"deleted": true,
"transfer": "HOLDACH000024"
}Get bank account
Get one account with its bank branch, account number, currency, statement settings and payment settings.
Inputs
- Bank account
accounttextRequired - The account. Pick one, or give its code or UUID.
Outputs
accountobject- The account
Example output
{
"account": {
"accountAvailableForPayments": true,
"accountType": "BANK_ACCOUNT",
"bankAccountID": {
"banStructure": "LBAN_1_STRUCTURE",
"statementIdentifier": "123456789",
"value": "123456789"
},
"branch": {
"code": "CITI_NY",
"uuid": ""
},
"closedAccount": false,
"closingDate": "",
"code": "USD_OPER",
"company": {
"code": "ACME_US",
"uuid": "5f1c9b0e-2b7d-4d38-9a6e-3c2f1e0b9a11"
},
"currency": {
"code": "USD",
"uuid": "0a8d3f8e-6a1c-4c7f-9d5e-1b2c3d4e5f60"
},
"description": "US operating account",
"openingDate": "2026-01-12",
"timeZone": "America/New_York",
"uuid": "c890b2e8-a5fa-413b-b53a-85729d16317b"
}
}Get bank statement balance
Get the balance a bank reported for an account on a day, from its bank statements, with the day of the latest one.
Inputs
- Bank account
accounttextRequired - The account. Pick one, or give its code or UUID.
- Date
datedateRequired - The day of the balance.
- Balance type
balance_typetext - End of day or intraday. Defaults to end of day.One of:
END_OF_DAY(End of day),INTRADAY.
Outputs
accountobject- The account
balanceobject- The statement balance
Example output
{
"account": {
"code": "USD_OPER",
"statementIdentifier": "123456789",
"uuid": "c890b2e8-a5fa-413b-b53a-85729d16317b"
},
"balance": {
"amount": 1248730.55,
"balanceDate": "2026-11-12",
"currencyCode": "USD",
"lastKnownBalanceDate": "2026-11-11"
}
}Get cash balance
Get an account's cash balance for each day of a period, counting actuals and the forecasts you choose.
Inputs
- Bank account
accounttextRequired - The account. Pick one, or give its code or UUID.
- From
start_datedateRequired - The first day.
- Until
end_datedateRequired - The last day.
- Date type
date_typetext - Which date of each cash flow places it in a day. Defaults to value date.One of:
VALUE(Value date),TRANSACTION(Transaction date). - Count
includelist - Which cash flows the balance counts. Defaults to actuals and confirmed forecasts.One or more of:
actual(Actuals),confirmedForecasts(Confirmed forecasts),estimatedForecasts(Estimated forecasts),intraday.
Outputs
accountobject- The account
balanceslist- The balance on each day
countnumber- How many days
includedlist- Which cash flows were counted
Example output
{
"account": {
"code": "USD_OPER",
"statementIdentifier": "123456789",
"uuid": "c890b2e8-a5fa-413b-b53a-85729d16317b"
},
"balances": [
{
"amount": 1250000.0,
"balanceDate": {
"date": "2026-11-12",
"dateType": "VALUE"
},
"currencyCode": "USD"
}
],
"count": 1,
"included": [
"actual",
"confirmedForecasts"
]
}Get cash flow
Get one cash flow with its account, code, amount, dates and status.
Inputs
- Cash flow UUID
cash_flow_idtextRequired - The cash flow's UUID, from 'List cash flows' or 'Create cash flow'.
Outputs
cash_flowobject- The cash flow
Example output
{
"cash_flow": {
"account": {
"code": "USD_OPER",
"uuid": "c890b2e8-a5fa-413b-b53a-85729d16317b"
},
"budgetCode": {
"code": "OPCOLL",
"uuid": ""
},
"date": {
"accountingDate": "2026-11-12",
"transactionDate": "2026-11-12",
"valueDate": "2026-11-13"
},
"description": "Customer payment",
"flowAmount": {
"amount": 10580.12,
"currency": {
"code": "USD",
"uuid": "0a8d3f8e-6a1c-4c7f-9d5e-1b2c3d4e5f60"
}
},
"flowCode": {
"code": "+WIRE",
"uuid": "8b4f2c1d-9e7a-4b3c-8d2e-6f5a4b3c2d1e"
},
"number": 1,
"origin": "API",
"reference": "INV-1042",
"status": "CONFIRMED",
"uuid": "a300ec56-7e3d-4c14-935f-a0fe25bef270"
}
}Get company
Get one company with its address, currencies, legal details and contacts.
Inputs
- Company
companytextRequired - The company. Pick one, or give its code or UUID.
Outputs
companyobject- The company
Example output
{
"company": {
"address": {
"country": {
"code": "US",
"uuid": ""
}
},
"code": "ACME_US",
"defaultGroup": {
"code": "AMERICAS",
"uuid": ""
},
"description1": "Acme Corporation US",
"description2": "",
"interfaceCode": "ACME_US",
"shortCode": "ACU",
"uuid": "5f1c9b0e-2b7d-4d38-9a6e-3c2f1e0b9a11"
}
}Get payment file log
Get a payment file's status and processing log, to see why it was rejected or where it is.
Inputs
- Payment file UUID
payment_file_idtextRequired - The payment file's UUID, from 'List payment files'.
Outputs
payment_fileobject- The payment file
Example output
{
"payment_file": {
"log": "File received. Transmitted to bank.",
"status": "TRANSMITTED",
"uuid": "9c8b7a6f-5e4d-4c3b-2a19-0f8e7d6c5b4a"
}
}Get result file
Get the file a process template's task made, such as an export or report: its text, or its bytes in base64 for a PDF or spreadsheet.
Inputs
- Process template
templatetextRequired - The process template. Pick one, or give its code or UUID.
- Task UUID
task_idtextRequired - The task's UUID, from 'Run process template'.
Outputs
contenttext- The file's text, for a text file
content_base64text- The file's bytes in base64, for any other file
content_typetext- The file's type, such as text/csv
file_nametext- The file's name, when Kyriba gives one
is_texttrue/false- True when the file is text
size_bytesnumber- The file's size in bytes
task_idtext- The task
templatetext- The template
Example output
{
"content": "account,date,amount\nUSD_OPER,2026-11-11,10580.12\n",
"content_base64": "",
"content_type": "text/csv",
"file_name": "actuals.csv",
"is_text": true,
"size_bytes": 58,
"task_id": "123e4567-e89b-12d3-a456-426655440001",
"template": "EXP_ACTUALS"
}Get task status
Get the status, times and log of a task a process template started.
Inputs
- Task UUID
task_idtextRequired - The task's UUID, from 'Run process template'.
Outputs
descriptiontext- What the task is
ended_attext- When it ended, once it has
loglist- The task's log lines
started_attext- When it started
statustext- The task's status
sub_taskslist- The tasks it is made of
task_idtext- The task's UUID
typetext- The kind of task
Example output
{
"description": "Export bank actuals",
"ended_at": "2026-11-12T09:30:42Z",
"log": [
"Export completed: 412 lines"
],
"started_at": "2026-11-12T09:30:00Z",
"status": "Complete",
"sub_tasks": [],
"task_id": "123e4567-e89b-12d3-a456-426655440001",
"type": "EXPORT"
}Get third party
Get one third party with its address, contact, bank accounts and the companies that use it.
Inputs
- Third party
third_partytextRequired - The third party. Pick one, or give its code or UUID.
Outputs
third_partyobject- The third party
Example output
{
"third_party": {
"closureDate": "",
"code": "SUPP001",
"creditor": true,
"debtor": false,
"memo": "",
"name": "Globex Supplies",
"name2": "",
"thirdPartyType": "ORGANIZATION",
"uuid": "7e6d5c4b-3a29-4180-9f8e-7d6c5b4a3928"
}
}List bank accounts
List bank and intercompany accounts with their company, bank, currency, IBAN and status, filtered by company, currency, status or type. Gets one page; to read on, run it again with the 'next_offset' it gives.
Inputs
- Company
companytext - Only accounts of this company.
- Currency
currencytext - Only accounts in this currency.
- Status
statustext - Only open or only closed ones. Leave empty for both.One of:
OPENED(Open),CLOSED. - Account type
account_typetext - Only accounts of this type.One of:
BANK_ACCOUNT(Bank account),INTERCOMPANY_ACCOUNT(Intercompany account),SHARED_ACCOUNT(Shared account),OTHER_ACCOUNT(Other account). - Only accounts that can pay
available_for_paymentstrue/false - Turn on to list only accounts payments can be made from.
- Page size
limitnumber - How many to return, 1 to 1,000. Defaults to 100.From 1 to 1000.
- Offset
offsetnumber - How many to skip, to read on: give the 'next_offset' an earlier page returned.At least 0.
Outputs
accountslist- The accounts
countnumber- How many are on this page
has_moretrue/false- True when there may be another page
next_offsetnumber- The offset to give for the next page; 0 when this is the last
offsetnumber- How many were skipped before this page
totalnumber- How many match in all, as Kyriba counts them
Example output
{
"accounts": [
{
"accountAvailableForPayments": true,
"accountType": "BANK_ACCOUNT",
"activeStatus": "OPENED",
"banCode": "123456789",
"bank": {
"code": "CITIUS33",
"uuid": ""
},
"branch": {
"code": "CITI_NY",
"uuid": ""
},
"closingDate": "",
"code": "USD_OPER",
"company": {
"code": "ACME_US",
"uuid": "5f1c9b0e-2b7d-4d38-9a6e-3c2f1e0b9a11"
},
"countryCode": "US",
"creationDate": "2026-01-12",
"currency": {
"code": "USD",
"uuid": "0a8d3f8e-6a1c-4c7f-9d5e-1b2c3d4e5f60"
},
"description": "US operating account",
"ibanCode": "",
"statementIdentifier": "123456789",
"updateDate": "2026-10-02",
"uuid": "c890b2e8-a5fa-413b-b53a-85729d16317b"
}
],
"count": 1,
"has_more": false,
"next_offset": 0,
"offset": 0,
"total": 1
}List banks
List the banks set up in Kyriba, with their codes and countries. Gets one page; to read on, run it again with the 'next_offset' it gives.
Inputs
- Country
country_codetext - Only those in this country, as a two-letter code such as US.
- Page size
limitnumber - How many to return, 1 to 1,000. Defaults to 100.From 1 to 1000.
- Offset
offsetnumber - How many to skip, to read on: give the 'next_offset' an earlier page returned.At least 0.
Outputs
bankslist- The banks
countnumber- How many are on this page
has_moretrue/false- True when there may be another page
next_offsetnumber- The offset to give for the next page; 0 when this is the last
offsetnumber- How many were skipped before this page
totalnumber- How many match in all, as Kyriba counts them
Example output
{
"banks": [
{
"code": "CITIUS33",
"countryCode": "US",
"description": "Citibank N.A.",
"intercompany": false,
"interfaceCode": "CITIUS33",
"uuid": "2d1c0b9a-8f7e-4d6c-5b4a-3f2e1d0c9b8a"
}
],
"count": 1,
"has_more": false,
"next_offset": 0,
"offset": 0,
"total": 1
}List cash flow codes
List the cash flow codes that classify cash flows, such as incoming wires or supplier payments. Gets one page; to read on, run it again with the 'next_offset' it gives.
Inputs
- Description contains
descriptiontext - Only codes whose description contains this.
- Page size
limitnumber - How many to return, 1 to 1,000. Defaults to 100.From 1 to 1000.
- Offset
offsetnumber - How many to skip, to read on: give the 'next_offset' an earlier page returned.At least 0.
Outputs
cash_flow_codeslist- The cash flow codes
countnumber- How many are on this page
has_moretrue/false- True when there may be another page
next_offsetnumber- The offset to give for the next page; 0 when this is the last
offsetnumber- How many were skipped before this page
totalnumber- How many match in all, as Kyriba counts them
Example output
{
"cash_flow_codes": [
{
"budgetCode": {
"code": "OPCOLL",
"uuid": ""
},
"code": "+WIRE",
"description": "Incoming wire",
"type": "COLLECTION",
"uuid": "8b4f2c1d-9e7a-4b3c-8d2e-6f5a4b3c2d1e"
}
],
"count": 1,
"has_more": false,
"next_offset": 0,
"offset": 0,
"total": 1
}List cash flows
List cash flows (forecasts, actuals and intraday movements) in a date range, by account, cash flow code, status or reference. Gets one page; to read on, run it again with the 'next_offset' it gives.
Inputs
- From
start_datedate - The first day. Defaults to today.
- Until
end_datedate - The last day. Defaults to today.
- Date type
date_typetext - Which date the range is on. Defaults to transaction date.One of:
TRANSACTION(Transaction date),VALUE(Value date),ACCOUNTING(Accounting date),CREATION(Date it was created),UPDATE(Date it last changed). - Bank account
accounttext - Only cash flows on this account.
- Cash flow code
flow_codetext - Only cash flows with this code.
- Status
statustext - Only cash flows with this status.One of:
ESTIMATED(Estimated (forecast)),CONFIRMED(Confirmed (forecast)),ACTUAL,INTRADAY. - Reference
referencetext - Only cash flows with exactly this reference.
- Page size
limitnumber - How many to return, 1 to 1,000. Defaults to 100.From 1 to 1000.
- Offset
offsetnumber - How many to skip, to read on: give the 'next_offset' an earlier page returned.At least 0.
Outputs
cash_flowslist- The cash flows
countnumber- How many are on this page
has_moretrue/false- True when there may be another page
next_offsetnumber- The offset to give for the next page; 0 when this is the last
offsetnumber- How many were skipped before this page
totalnumber- How many match in all, as Kyriba counts them
Example output
{
"cash_flows": [
{
"account": {
"code": "USD_OPER",
"uuid": "c890b2e8-a5fa-413b-b53a-85729d16317b"
},
"actualMode": "",
"budgetCode": {
"code": "OPCOLL",
"uuid": ""
},
"date": {
"accountingDate": "2026-11-12",
"transactionDate": "2026-11-12",
"valueDate": "2026-11-13"
},
"description": "Customer payment",
"flowAmount": {
"amount": 10580.12,
"currency": {
"code": "USD",
"uuid": "0a8d3f8e-6a1c-4c7f-9d5e-1b2c3d4e5f60"
},
"signedAmount": 10580.12
},
"flowCode": {
"code": "+WIRE",
"uuid": "8b4f2c1d-9e7a-4b3c-8d2e-6f5a4b3c2d1e"
},
"glStatus": "FORECAST",
"origin": "API",
"reference": "INV-1042",
"status": "CONFIRMED",
"uuid": "a300ec56-7e3d-4c14-935f-a0fe25bef270"
}
],
"count": 1,
"has_more": false,
"next_offset": 0,
"offset": 0,
"total": 1
}List companies
List the companies (legal entities) set up in Kyriba, by name or country. Gets one page; to read on, run it again with the 'next_offset' it gives.
Inputs
- Name contains
nametext - Only companies whose name contains this.
- Country
country_codetext - Only those in this country, as a two-letter code such as US.
- Page size
limitnumber - How many to return, 1 to 1,000. Defaults to 100.From 1 to 1000.
- Offset
offsetnumber - How many to skip, to read on: give the 'next_offset' an earlier page returned.At least 0.
Outputs
companieslist- The companies
countnumber- How many are on this page
has_moretrue/false- True when there may be another page
next_offsetnumber- The offset to give for the next page; 0 when this is the last
offsetnumber- How many were skipped before this page
totalnumber- How many match in all, as Kyriba counts them
Example output
{
"companies": [
{
"address": {
"country": {
"code": "US",
"uuid": ""
}
},
"code": "ACME_US",
"defaultGroup": {
"code": "AMERICAS",
"uuid": ""
},
"description1": "Acme Corporation US",
"description2": "",
"interfaceCode": "ACME_US",
"shortCode": "ACU",
"uuid": "5f1c9b0e-2b7d-4d38-9a6e-3c2f1e0b9a11"
}
],
"count": 1,
"has_more": false,
"next_offset": 0,
"offset": 0,
"total": 1
}List currencies
List the currencies set up in Kyriba, with their decimals and which is the reference currency. Gets one page; to read on, run it again with the 'next_offset' it gives.
Inputs
- Page size
limitnumber - How many to return, 1 to 1,000. Defaults to 100.From 1 to 1000.
- Offset
offsetnumber - How many to skip, to read on: give the 'next_offset' an earlier page returned.At least 0.
Outputs
countnumber- How many are on this page
currencieslist- The currencies
has_moretrue/false- True when there may be another page
next_offsetnumber- The offset to give for the next page; 0 when this is the last
offsetnumber- How many were skipped before this page
totalnumber- How many match in all, as Kyriba counts them
Example output
{
"count": 1,
"currencies": [
{
"code": "USD",
"description": "US Dollar",
"hideInList": false,
"numberOfDecimals": 2,
"reference": true,
"uuid": "0a8d3f8e-6a1c-4c7f-9d5e-1b2c3d4e5f60"
}
],
"has_more": false,
"next_offset": 0,
"offset": 0,
"total": 1
}List payment files
List bulk payment files sent through Kyriba, with their status, next action and acknowledgements. Gets one page; to read on, run it again with the 'next_offset' it gives.
Inputs
- File name
file_nametext - Only the file with this name.
- Page size
limitnumber - How many to return, 1 to 1,000. Defaults to 100.From 1 to 1000.
- Offset
offsetnumber - How many to skip, to read on: give the 'next_offset' an earlier page returned.At least 0.
Outputs
countnumber- How many are on this page
has_moretrue/false- True when there may be another page
next_offsetnumber- The offset to give for the next page; 0 when this is the last
offsetnumber- How many were skipped before this page
payment_fileslist- The payment files
totalnumber- How many match in all, as Kyriba counts them
Example output
{
"count": 1,
"has_more": false,
"next_offset": 0,
"offset": 0,
"payment_files": [
{
"creationDateTime": "2026-11-12T09:30:00Z",
"fileName": "payments-20261112.txt",
"lastACK": {
"bankACK": "",
"kyribaACK": "SENT",
"lastACKTime": "2026-11-12T09:35:00Z"
},
"nextAction": "WAIT_ANSWER",
"status": "TRANSMITTED",
"uuid": "9c8b7a6f-5e4d-4c3b-2a19-0f8e7d6c5b4a"
}
],
"total": 1
}List process templates
List process templates: Kyriba's saved imports, exports, reports and processes. Gets one page; to read on, run it again with the 'next_offset' it gives.
Inputs
- Only ones I can run
launchable_onlytrue/false - Turn off to list templates the API user can't run too. On by default.Default:
true. - Module
moduletext - Only templates of this Kyriba module.
- Page size
limitnumber - How many to return, 1 to 1,000. Defaults to 100.From 1 to 1000.
- Offset
offsetnumber - How many to skip, to read on: give the 'next_offset' an earlier page returned.At least 0.
Outputs
countnumber- How many are on this page
has_moretrue/false- True when there may be another page
next_offsetnumber- The offset to give for the next page; 0 when this is the last
offsetnumber- How many were skipped before this page
templateslist- The process templates
totalnumber- How many match in all, as Kyriba counts them
Example output
{
"count": 1,
"has_more": false,
"next_offset": 0,
"offset": 0,
"templates": [
{
"category": "Export",
"code": "EXP_ACTUALS",
"description": "Export bank actuals",
"module": "Cash",
"type": "EXPORT",
"uuid": "3f2e1d0c-9b8a-4776-a655-443322110099"
}
],
"total": 1
}List third parties
List third parties (suppliers, customers and other counterparties) by name or status. Gets one page; to read on, run it again with the 'next_offset' it gives.
Inputs
- Name contains
nametext - Only third parties whose name contains this.
- Status
statustext - Only open or only closed ones. Leave empty for both.One of:
OPENED(Open),CLOSED. - Page size
limitnumber - How many to return, 1 to 1,000. Defaults to 100.From 1 to 1000.
- Offset
offsetnumber - How many to skip, to read on: give the 'next_offset' an earlier page returned.At least 0.
Outputs
countnumber- How many are on this page
has_moretrue/false- True when there may be another page
next_offsetnumber- The offset to give for the next page; 0 when this is the last
offsetnumber- How many were skipped before this page
third_partieslist- The third parties
totalnumber- How many match in all, as Kyriba counts them
Example output
{
"count": 1,
"has_more": false,
"next_offset": 0,
"offset": 0,
"third_parties": [
{
"activeStatus": "OPENED",
"code": "SUPP001",
"companyOwnership": {
"code": "ACME_US",
"uuid": ""
},
"creationDate": "2026-03-04",
"name": "Globex Supplies",
"name2": "",
"updateDate": "2026-09-30",
"uuid": "7e6d5c4b-3a29-4180-9f8e-7d6c5b4a3928"
}
],
"total": 1
}List transfers
List payment transfers with their status, next action, batch and the bank's last acknowledgement, by file, transaction number, reference or batch. Gets one page; to read on, run it again with the 'next_offset' it gives.
Inputs
- Payment file name
file_nametext - Only transfers from this payment file.
- Transaction number
transaction_numbertext - Only the transfer with this transaction number.
- Reference
referencetext - Only transfers with this reference.
- Batch ID
batch_idtext - Only transfers in this batch (remittance).
- Page size
limitnumber - How many to return, 1 to 1,000. Defaults to 100.From 1 to 1000.
- Offset
offsetnumber - How many to skip, to read on: give the 'next_offset' an earlier page returned.At least 0.
Outputs
countnumber- How many are on this page
has_moretrue/false- True when there may be another page
next_offsetnumber- The offset to give for the next page; 0 when this is the last
offsetnumber- How many were skipped before this page
totalnumber- How many match in all, as Kyriba counts them
transferslist- The transfers
Example output
{
"count": 1,
"has_more": false,
"next_offset": 0,
"offset": 0,
"total": 1,
"transfers": [
{
"ackInfo": {
"lastACK": "",
"lastACKTime": "",
"reasonCode": "",
"reasonDescription": ""
},
"fileName": "payments-20261112.txt",
"nextAction": "SEND_THE_REMITTANCE_FILE",
"reference": "PAY_REF_001",
"remittance": {
"batchId": "DOMTCOM00742",
"status": "GENERATED"
},
"status": "REMITTED",
"transactionNumber": "HOLDACH000024",
"uuid": "547636a4-c07f-48fb-8577-1a2b3c4d5e6f"
}
]
}List users
List Kyriba users with their access profile and when they last signed in, by email or last name. Gets one page; to read on, run it again with the 'next_offset' it gives.
Inputs
- Email
emailtext - Only the user with this email address.
- Last name contains
last_nametext - Only users whose last name contains this.
- Page size
limitnumber - How many to return, 1 to 1,000. Defaults to 100.From 1 to 1000.
- Offset
offsetnumber - How many to skip, to read on: give the 'next_offset' an earlier page returned.At least 0.
Outputs
countnumber- How many are on this page
has_moretrue/false- True when there may be another page
next_offsetnumber- The offset to give for the next page; 0 when this is the last
offsetnumber- How many were skipped before this page
totalnumber- How many match in all, as Kyriba counts them
userslist- The users
Example output
{
"count": 1,
"has_more": false,
"next_offset": 0,
"offset": 0,
"total": 1,
"users": [
{
"accessProfile": {
"code": "TREASURY",
"uuid": ""
},
"active": true,
"apiUser": false,
"code": "JDOE",
"email": "jane.doe@example.com",
"firstName": "Jane",
"lastLoginDate": "2026-11-11T16:02:00Z",
"lastName": "Doe",
"uuid": "4b3a2918-0f7e-4d6c-8b5a-49382716a5b4"
}
]
}Run process template
Start a process template, such as an export of bank actuals or a report. It runs in Kyriba; follow it with 'Get task status'.
Inputs
- Process template
templatetextRequired - The process template. Pick one, or give its code or UUID.
- Report format
report_formattext - For a report template only: the format to make it in. Leave empty for the template's own.One of:
csv,xlsx(Excel (xlsx)),xls(Excel 97 (xls)),pdf,html,htmlfp(HTML (full page)).
Outputs
statustext- The task's status when it started
task_idtext- The task's UUID, for 'Get task status'
taskslist- Every task it started
templatetext- The template run
Example output
{
"status": "Pending",
"task_id": "123e4567-e89b-12d3-a456-426655440001",
"tasks": [
{
"file_id": "",
"status": "Pending",
"task_id": "123e4567-e89b-12d3-a456-426655440001"
}
],
"template": "EXP_ACTUALS"
}Update cash flow
Change a cash flow's amount, currency, status, code, dates, description or reference. Fields left empty keep their values.
Inputs
- Cash flow UUID
cash_flow_idtextRequired - The cash flow's UUID, from 'List cash flows' or 'Create cash flow'.
- Amount
amountnumber - The new amount.
- Currency
currencytext - The new currency.
- Status
statustext - The new status.One of:
ESTIMATED(Estimated (forecast)),CONFIRMED(Confirmed (forecast)),ACTUAL,INTRADAY. - Cash flow code
flow_codetext - The new cash flow code.
- Transaction date
transaction_datedate - The new transaction date.
- Value date
value_datedate - The new value date.
- Accounting date
accounting_datedate - The new accounting date.
- Budget code
budget_codetext - The new budget code.
- Description
descriptiontext - The new description.
- Reference
referencetext - The new reference.
Outputs
cash_flow_idtext- The cash flow's UUID
updatedtrue/false- Always true once updated
Example output
{
"cash_flow_id": "a300ec56-7e3d-4c14-935f-a0fe25bef270",
"updated": true
}