Agicap Treasury Bank Journal (v1)
Export bank journal entries prepared in our Treasury product.
OpenAPI Specification
{
"components": {
"schemas": {
"AccountingAccountTypeDto": {
"enum": [
"OTHER",
"SUPPLIER",
"CLIENT",
"EXPENSE",
"PRODUCT",
"VAT",
"BANK"
],
"type": "string"
},
"BankJournalExportSummaryDto": {
"additionalProperties": false,
"description": "A bank journal export description.",
"properties": {
"exportDateUtc": {
"description": "The export date-time in UTC format",
"example": "2024-10-28T14:30:59.999Z",
"type": "string"
},
"exportId": {
"description": "Unique ID of the export.",
"example": "31dee215-e458-4145-8fe8-c20a0ea06042",
"format": "uuid",
"type": "string"
},
"exportIndexInYear": {
"description": "The index of the bank journal export in the `ExportYear` (index starting at 1)",
"example": 12,
"format": "int32",
"type": "integer"
},
"exportYear": {
"description": "The year the export was done",
"example": 2024,
"format": "int32",
"type": "integer"
},
"indexInYearOfFirstEntryInBankJournal": {
"description": "The index in `ExportYear` of the first entry in the bank journal export (index\nstarting at 1)",
"example": 105,
"format": "int32",
"type": "integer"
},
"indexInYearOfLastEntryInBankJournal": {
"description": "The index in `ExportYear` of the last entry in the bank journal export (index\nstarting at 1)",
"example": 120,
"format": "int32",
"type": "integer"
},
"numberOfEntries": {
"description": "The number of entries in the bank journal export",
"example": 16,
"format": "int32",
"type": "integer"
}
},
"required": [
"exportDateUtc",
"exportId",
"exportIndexInYear",
"exportYear",
"indexInYearOfFirstEntryInBankJournal",
"indexInYearOfLastEntryInBankJournal",
"numberOfEntries"
],
"type": "object"
},
"CausaleRequestDto": {
"additionalProperties": false,
"properties": {
"code": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"code",
"description"
],
"type": "object"
},
"CausalesRequestDto": {
"additionalProperties": false,
"properties": {
"causales": {
"items": {
"$ref": "#/components/schemas/CausaleRequestDto"
},
"type": "array"
}
},
"required": [
"causales"
],
"type": "object"
},
"CurrentExportCountsDto": {
"additionalProperties": false,
"description": "Optional export parameters allowing to set where to start:\n<ul><li>the count of already created bank journal in the current year </li><li>the count of already created bank journal entries in the current year</li></ul>\nThis is needed if there were bank journal already created outside Agicap systems, Agicap needs to know where to pick up the counts.",
"properties": {
"currentBankJournalEntriesCountInYear": {
"description": "The number of bank journal entries previously created (starts at 1)",
"format": "int32",
"type": "integer"
},
"currentBankJournalsCountInYear": {
"description": "The number of bank journal previously created (starts at 1)",
"format": "int32",
"type": "integer"
}
},
"required": [
"currentBankJournalEntriesCountInYear",
"currentBankJournalsCountInYear"
],
"type": "object"
},
"CursorDto": {
"additionalProperties": false,
"description": "The cursor current state as returned after a query.\nBoth <i>after</i> and <i>before</i> values are ISO 8601 date/time in UTC in this format: 2024-10-28T14:30:00.123Z.",
"properties": {
"after": {
"description": "The export date in UTC of the newest returned bank journal export (only if the request specified the <i>after</i> parameter",
"example": "2024-11-01T09:45:00.000Z",
"nullable": true,
"type": "string"
},
"before": {
"description": "The export date in UTC of the oldest returned bank journal export (only if the request specified the <i>before</i> parameter",
"example": "2024-10-28T14:30:59.999Z",
"nullable": true,
"type": "string"
},
"size": {
"description": "The number of exported bank journals returned (might be different from the requested size)",
"example": 100,
"format": "int32",
"type": "integer"
}
},
"required": [
"size"
],
"type": "object"
},
"CustomFieldDto": {
"additionalProperties": false,
"description": "A custom field",
"properties": {
"name": {
"description": "The custom field name",
"type": "string"
},
"value": {
"description": "The custom field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"DocumentDto": {
"additionalProperties": false,
"description": "Document related (invoice, credit note, purchase order, etc) information",
"properties": {
"documentIssueDate": {
"description": "The document issue date",
"format": "date-time",
"nullable": true,
"type": "string"
},
"documentReference": {
"description": ">The document reference number (e.g., invoice number, purchase order number)",
"nullable": true,
"type": "string"
},
"documentType": {
"description": "The document type (CLIENT_INVOICE, CLIENT_CREDIT_NOTE, SUPPLIER_INVOICE, SUPPLIER_CREDIT_NOTE, CLIENT_QUOTE, SALES_ORDER,\nPURCHASE_ORDER, PROFORMA_INVOICE, OTHER)",
"type": "string"
},
"externalEntityId": {
"description": "The external identifier of the owning entity in the source system",
"nullable": true,
"type": "string"
},
"externalId": {
"description": "The document identifier from the source system",
"nullable": true,
"type": "string"
},
"originalDueDate": {
"description": "The document due date",
"format": "date",
"type": "string"
},
"uniqueId": {
"description": "A unique 8-character alphanumeric identifier for the document",
"type": "string"
}
},
"required": [
"documentType",
"originalDueDate",
"uniqueId"
],
"type": "object"
},
"ErrorDto": {
"additionalProperties": false,
"description": "Describes a single error when failing to import a bank journal entry in the client accounting system.",
"properties": {
"errorMessage": {
"description": "Optional error message",
"nullable": true,
"type": "string"
},
"errorType": {
"allOf": [
{
"$ref": "#/components/schemas/ErrorTypeDto"
}
],
"description": "Mandatory error type"
}
},
"required": [
"errorType"
],
"type": "object"
},
"ErrorTypeDto": {
"description": "Describes the types of errors when failing to import a bank journal entry in the client accounting system.",
"enum": [
"UNKNOWN_JOURNAL_CODE",
"UNKNOWN_ACCOUNTING_ACCOUNT",
"UNKNOWN_THIRD_PARTY",
"UNKNOWN_ANALYTICAL_CODE",
"OTHER"
],
"type": "string"
},
"ExportRequest": {
"additionalProperties": false,
"description": "Export request",
"properties": {
"currentExportCounts": {
"allOf": [
{
"$ref": "#/components/schemas/CurrentExportCountsDto"
}
],
"description": "Optional export parameters allowing to set where to start:\n<ul><li>the count of already created bank journal in the current year </li><li>the count of already created bank journal entries in the current year</li></ul>\nThis is needed if there were bank journal already created outside Agicap systems, Agicap needs to know where to pick up the counts.",
"nullable": true
}
},
"type": "object"
},
"ExportResponse": {
"additionalProperties": false,
"description": "Export response",
"properties": {
"bankJournalExportIndexInYear": {
"description": "The index of the bank journal export in the current year",
"format": "int32",
"type": "integer"
},
"entityName": {
"description": "Name of the entity",
"type": "string"
},
"entries": {
"description": "List of all entries in the bank journal export",
"items": {
"$ref": "#/components/schemas/ExportedBankJournalEntryDto"
},
"type": "array"
},
"exportId": {
"description": "The identifier of the export as specified in the request",
"format": "uuid",
"type": "string"
},
"year": {
"description": "Current year in UTC when the bank journal has been exported",
"format": "int32",
"type": "integer"
}
},
"required": [
"bankJournalExportIndexInYear",
"entityName",
"entries",
"exportId",
"year"
],
"type": "object"
},
"ExportedBankJournalEntryDto": {
"additionalProperties": false,
"description": "A bank journal entry",
"properties": {
"accountingAccountExternalId": {
"description": "An optional ERP-specific external identifier for the bank accounting account",
"nullable": true,
"type": "string"
},
"accountingAccountNumber": {
"description": "The accounting account number",
"type": "string"
},
"accountingCurrency": {
"description": "The accounting currency ISO code on three uppercase letters (ISO 4217 standard)",
"type": "string"
},
"agicapUniqueId": {
"description": "A unique id generated by Agicap",
"format": "uuid",
"type": "string"
},
"bankAccountName": {
"description": "The bank account name",
"type": "string"
},
"causale": {
"description": "The banking transaction causale (only populated for entities with causale option enabled)",
"nullable": true,
"type": "string"
},
"counterparts": {
"description": "The bank journal entry counterparts",
"items": {
"$ref": "#/components/schemas/ExportedCounterpartDto"
},
"type": "array"
},
"creditInAccountingCurrency": {
"description": "Credit value in accounting currency (rounded to four decimals)",
"format": "double",
"nullable": true,
"type": "number"
},
"creditInOriginalCurrency": {
"description": "Credit value in original currency (rounded to four decimals)",
"format": "double",
"nullable": true,
"type": "number"
},
"debitInAccountingCurrency": {
"description": "Debit value in accounting currency (rounded to four decimals)",
"format": "double",
"nullable": true,
"type": "number"
},
"debitInOriginalCurrency": {
"description": "Debit value in original currency (rounded to four decimals)",
"format": "double",
"nullable": true,
"type": "number"
},
"entryMemo": {
"description": "A free-text memo for the bank journal entry",
"nullable": true,
"type": "string"
},
"exchangeRate": {
"description": "The exchange rate applied between the original currency amount and the accounting currency amount (rounded to six decimals). Null when the rate is not applicable (e.g., synthetic exchange gain/loss counterpart, or when the original amount is zero).",
"format": "double",
"nullable": true,
"type": "number"
},
"exportEntryReference": {
"description": "A unique reference per entity generated by Agicap, max 8 characters, designed to match reference formats expected by ERPs and accounting systems",
"type": "string"
},
"indexInExport": {
"description": "Index of the bank journal entry in the bank journal (starts at 1)",
"format": "int32",
"type": "integer"
},
"indexInYear": {
"description": "Index of the bank journal entry in the current year (starts at 1)",
"format": "int32",
"type": "integer"
},
"journalCode": {
"description": "The journal code",
"nullable": true,
"type": "string"
},
"name": {
"description": "The bank journal entry name (title)",
"type": "string"
},
"originalCurrency": {
"description": "The original currency ISO code on three uppercase letters (ISO 4217 standard)",
"type": "string"
},
"paymentDate": {
"description": "The banking transaction payment date",
"format": "date",
"type": "string"
},
"type": {
"description": "The journal entry type: 'BANK' for bank journal entries, 'CASH_IN_TRANSIT' for cash-in-transit entries.",
"type": "string"
}
},
"required": [
"accountingAccountNumber",
"accountingCurrency",
"agicapUniqueId",
"bankAccountName",
"counterparts",
"exportEntryReference",
"indexInExport",
"indexInYear",
"name",
"originalCurrency",
"paymentDate",
"type"
],
"type": "object"
},
"ExportedCounterpartDto": {
"additionalProperties": false,
"description": "A bank journal entry counterpart",
"properties": {
"accountingAccountExternalId": {
"description": "An optional ERP-specific external identifier for the accounting account",
"nullable": true,
"type": "string"
},
"accountingAccountNumber": {
"description": "The accounting account number",
"type": "string"
},
"accountingAccountType": {
"allOf": [
{
"$ref": "#/components/schemas/AccountingAccountTypeDto"
}
],
"description": "The accounting account type (OTHER, SUPPLIER, CLIENT, EXPENSE, PRODUCT, VAT, BANK)"
},
"accountingCurrency": {
"description": "The accounting currency ISO code on three uppercase letters (ISO4217 standard)",
"nullable": true,
"type": "string"
},
"analyticalCodes": {
"additionalProperties": {
"type": "string"
},
"description": "The list of analytical codes of the counterpart",
"type": "object"
},
"creditInAccountingCurrency": {
"description": "Credit value in accounting currency (rounded to four decimals)",
"format": "double",
"nullable": true,
"type": "number"
},
"creditInOriginalCurrency": {
"description": "Credit value in original currency (rounded to four decimals)",
"format": "double",
"nullable": true,
"type": "number"
},
"customFields": {
"description": "Additional fields coming from the reconciled expected used to initialize the counterpart, they include the ERP identification fields from business document when imported in Agicap",
"items": {
"$ref": "#/components/schemas/CustomFieldDto"
},
"nullable": true,
"type": "array"
},
"debitInAccountingCurrency": {
"description": "Debit value in accounting currency (rounded to four decimals)",
"format": "double",
"nullable": true,
"type": "number"
},
"debitInOriginalCurrency": {
"description": "Debit value in original currency (rounded to four decimals)",
"format": "double",
"nullable": true,
"type": "number"
},
"document": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentDto"
}
],
"description": "Document related (invoice, credit note, purchase order, etc) information (reference, original due date, type)",
"nullable": true
},
"exchangeRate": {
"description": "The exchange rate applied between the original currency amount and the accounting currency amount (rounded to six decimals). Null when the rate is not applicable (e.g., synthetic exchange gain/loss counterpart, or when the original amount is zero).",
"format": "double",
"nullable": true,
"type": "number"
},
"journalCode": {
"description": "The journal code",
"nullable": true,
"type": "string"
},
"linkedExportedEntry": {
"allOf": [
{
"$ref": "#/components/schemas/LinkedExportedEntryDto"
}
],
"description": "Reference to a previously exported journal entry linked to this counterpart (used for ERP reconciliation)",
"nullable": true
},
"name": {
"description": "The counterpart name (title)",
"type": "string"
},
"originalCurrency": {
"description": "The original currency ISO code on three uppercase letters (ISO4217 standard)",
"type": "string"
},
"taxKey": {
"description": "Tax Key (only relevant for Vat accounting account)",
"nullable": true,
"type": "string"
},
"thirdPartyCode": {
"description": "The third party code",
"nullable": true,
"type": "string"
},
"thirdPartyExternalId": {
"description": "An optional ERP-specific external identifier for the third party",
"nullable": true,
"type": "string"
},
"thirdPartyName": {
"description": "The third party name",
"nullable": true,
"type": "string"
}
},
"required": [
"accountingAccountNumber",
"accountingAccountType",
"analyticalCodes",
"name",
"originalCurrency"
],
"type": "object"
},
"GetBankJournalExportsResponse": {
"additionalProperties": false,
"description": "A list of bank journal exports summaries along with a timestamp cursor pagination.\n",
"properties": {
"cursor": {
"allOf": [
{
"$ref": "#/components/schemas/CursorDto"
}
],
"description": "The cursor current state as returned after a query.\nBoth <i>after</i> and <i>before</i> values are ISO 8601 date/time in UTC in this format: 2024-10-28T14:30:00.123Z."
},
"items": {
"items": {
"$ref": "#/components/schemas/BankJournalExportSummaryDto"
},
"type": "array"
}
},
"required": [
"cursor",
"items"
],
"type": "object"
},
"GetExportResponse": {
"additionalProperties": false,
"description": "Get exported bank journal response",
"properties": {
"bankJournalExportIndexInYear": {
"description": "The index of the bank journal export in the current year",
"format": "int32",
"type": "integer"
},
"entityName": {
"description": "Name of the entity",
"type": "string"
},
"entries": {
"description": "Array of all entries in the bank journal export",
"items": {
"$ref": "#/components/schemas/ExportedBankJournalEntryDto"
},
"type": "array"
},
"exportId": {
"description": "The identifier of the export as specified in the request",
"format": "uuid",
"type": "string"
},
"year": {
"description": "Current year in UTC when the bank journal has been exported",
"format": "int32",
"type": "integer"
}
},
"required": [
"bankJournalExportIndexInYear",
"entityName",
"entries",
"exportId",
"year"
],
"type": "object"
},
"ImportedEntryDto": {
"additionalProperties": false,
"description": "Identifies a bank journal entry that was successfully imported in the client accounting system.",
"properties": {
"entryAgicapUniqueId": {
"description": "The agicapUniqueId of the exported bank journal entry",
"format": "uuid",
"type": "string"
}
},
"required": [
"entryAgicapUniqueId"
],
"type": "object"
},
"LinkedExportedEntryDto": {
"additionalProperties": false,
"description": "Reference to a previously exported journal entry linked to this counterpart",
"properties": {
"agicapUniqueId": {
"description": "The unique identifier of the linked entry (same format as ExportedBankJournalEntryDto.AgicapUniqueId)",
"format": "uuid",
"type": "string"
},
"exportEntryReference": {
"description": "The unique export reference of the linked entry (same format as ExportedBankJournalEntryDto.ExportEntryReference)",
"type": "string"
}
},
"required": [
"agicapUniqueId",
"exportEntryReference"
],
"type": "object"
},
"MarkAsImportedRequest": {
"additionalProperties": false,
"description": "Request to indicate Agicap that some exported bank journal entries from Agicap were successfully imported in the client accounting system.",
"properties": {
"entriesImported": {
"description": "The list of bank journal entries imported in the client accounting system (max 1000 entries)",
"items": {
"$ref": "#/components/schemas/ImportedEntryDto"
},
"type": "array"
}
},
"required": [
"entriesImported"
],
"type": "object"
},
"MarkAsNotImportedRequest": {
"additionalProperties": false,
"description": "Request to indicate Agicap that some exported bank journal entries from Agicap were not correctly imported in the client accounting system.",
"properties": {
"entriesNotImported": {
"description": "The list of bank journal entries not imported in the client accounting system with their errors description (max 1000 entries)",
"items": {
"$ref": "#/components/schemas/NotImportedEntryDto"
},
"type": "array"
}
},
"required": [
"entriesNotImported"
],
"type": "object"
},
"NotImportedEntryDto": {
"additionalProperties": false,
"description": "Describes all the errors that occured when failing to import a bank journal entry in the client accounting system.",
"properties": {
"entryAgicapUniqueId": {
"format": "uuid",
"type": "string"
},
"errors": {
"items": {
"$ref": "#/components/schemas/ErrorDto"
},
"type": "array"
}
},
"required": [
"entryAgicapUniqueId",
"errors"
],
"type": "object"
},
"ProblemDetails": {
"additionalProperties": false,
"properties": {
"detail": {
"nullable": true,
"type": "string"
},
"instance": {
"nullable": true,
"type": "string"
},
"status": {
"format": "int32",
"nullable": true,
"type": "integer"
},
"title": {
"nullable": true,
"type": "string"
},
"type": {
"nullable": true,
"type": "string"
}
},
"type": "object"
}
},
"securitySchemes": {
"bearerAuth": {
"bearerFormat": "OPAQUE",
"scheme": "bearer",
"type": "http"
},
"bearer_client_credentials": {
"description": "Client credentials: bearer",
"flows": {
"clientCredentials": {
"scopes": {
"agicap:public-api": ""
},
"tokenUrl": "https://myaccount.agicap.com/connect/token"
}
},
"type": "oauth2"
}
}
},
"info": {
"contact": {},
"description": "This API allows you to export bank journal entries that were produced in our Treasury product.\n\nThe main endpoint is: POST /public-api/treasury-bank-journal/v1/entities/{entityId}/exports/{exportId}, you can export the bank journal entries ready for export of the given entity (if there are no entries ready for export there, nothing is exported).\nTo generate this export, you need to provide a unique export ID (a guid), we record that an export with this ID has been performed.\n\nNote that the exported counterparts custom fields include the ERP identification fields from business document when imported in Agicap.\n\nAfter an export, if you have errors in the accounting system, you can report them back to Agicap through the endpoint: `POST /public-api/treasury-bank-journal/v1/entities/{entityId:int}/exported-bank-journal-entries/mark-as-not-imported.`\n\nUse the endpoint: GET /public-api/treasury-bank-journal/v1/entities/{entityId}/exports/{exportId} to get previous export, to do so, you need to provide the unique export ID used to create the export initially.\nThis endpoint is useful for support when you need to retrieve the bank journal entries already exported because something failed in downtream process and you want to reprocess the entries.\n\nUse the endpoint: GET /public-api/treasury-bank-journal/v1/entities/{entityId}/exports to retrieve the list of all the export IDs we have recorded for this entity, you can then easily find the export ID to call the GET /public-api/treasury-bank-journal/v1/entities/{entityId}/exports/{exportId} endpoint.\n",
"title": "Treasury Bank Journal",
"version": "v1"
},
"openapi": "3.0.0",
"paths": {
"/public/treasury-bank-journal/v1/entities/{entityId}/causales": {
"post": {
"operationId": "CreateCausales",
"parameters": [
{
"description": "Agicap entity identifier",
"example": 456897,
"in": "path",
"name": "entityId",
"required": true,
"schema": {
"format": "int32",
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/*+json": {
"example": {
"causales": [
{
"code": "Causale1Code",
"description": "Causale 1 Description"
},
{
"code": "Causale2Code",
"description": "Causale 2 Description"
}
]
},
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CausalesRequestDto"
}
]
}
},
"application/json": {
"example": {
"causales": [
{
"code": "Causale1Code",
"description": "Causale 1 Description"
},
{
"code": "Causale2Code",
"description": "Causale 2 Description"
}
]
},
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CausalesRequestDto"
}
]
}
},
"text/json": {
"example": {
"causales": [
{
"code": "Causale1Code",
"description": "Causale 1 Description"
},
{
"code": "Causale2Code",
"description": "Causale 2 Description"
}
]
},
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CausalesRequestDto"
}
]
}
}
},
"description": "Request body with the list of causales to create"
},
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "Unauthorized request."
},
"403": {
"description": "Forbidden request."
},
"429": {
"description": "Too many requests. Please try again later."
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "An internal server occurred."
}
},
"security": [
{
"bearer_client_credentials": [
"agicap:public-api"
]
},
{
"bearerAuth": []
}
],
"summary": "Create causales",
"tags": [
"Causales"
]
}
},
"/public/treasury-bank-journal/v1/entities/{entityId}/exported-bank-journal-entries/mark-as-imported": {
"post": {
"description": "Indicates Agicap that some exported bank journal entries from Agicap were successfully imported in the client accounting system.\n\n\nTo identify the exported bank journal entry, use the agicapUniqueId provided by Agicap during the export (see the POST Export operation response)\n\n\nEntries with pending corrections will have their corrections cancelled.\n\nUnknown agicapUniqueId values are silently ignored.\n\n\nThe maximum number of exported bank journal entries you can report is 1000 per request, if you need to report more,\nsimply call this endpoint as many times as necessary.",
"operationId": "MarkAsImported",
"parameters": [
{
"description": "Agicap entity identifier",
"example": 456897,
"in": "path",
"name": "entityId",
"required": true,
"schema": {
"format": "int32",
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MarkAsImportedRequest"
}
],
"description": "Request to indicate Agicap that some exported bank journal entries from Agicap were successfully imported in the client accounting system."
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MarkAsImportedRequest"
}
],
"description": "Request to indicate Agicap that some exported bank journal entries from Agicap were successfully imported in the client accounting system."
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MarkAsImportedRequest"
}
],
"description": "Request to indicate Agicap that some exported bank journal entries from Agicap were successfully imported in the client accounting system."
}
}
},
"description": "Request body with the list of bank journal entries successfully imported"
},
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "Unauthorized request."
},
"403": {
"description": "Forbidden request."
},
"429": {
"description": "Too many requests. Please try again later."
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "An internal server occurred."
}
},
"security": [
{
"bearer_client_credentials": [
"agicap:public-api"
]
},
{
"bearerAuth": []
}
],
"summary": "Indicates Agicap that some exported bank journal entries from Agicap were successfully imported in the client accounting system.",
"tags": [
"Export"
]
}
},
"/public/treasury-bank-journal/v1/entities/{entityId}/exported-bank-journal-entries/mark-as-not-imported": {
"post": {
"description": "Indicates Agicap that some exported bank journal entries from Agicap were not correctly imported in the client accounting system.\n\n\nYou can report several errors per bank journal entry. For each error, use the most precise error type whenever possible, and OTHER otherwise.\n\n\nTo identify the exported bank journal entry, use the agicapUniqueId provided by Agicap during the export (see the POST Export operation response)\n\nThis means, you need to keep track of which entry in the client accounting system corresponds to the agicapUniqueId.\n\n\nThe maximum number of exported bank journal entries you can report is 1000 per request, if you need to report more,\nsimply call this endpoint as many times as necessary.\n\n\nIn the example of an export response below, the id to use is \"agicapUniqueId\": \"f7f7ed5c-943c-4385-aa8d-145fd76b2fa1\":\n<pre>\n POST /public-api/treasury-bank-journal/v1/entities/{entityId}/exports/{exportId}\n {\n \"exportId\": \"7397d1b5-d76d-43d2-a153-2bcff5e57455\",\n \"year\": 2024,\n \"bankJournalExportIndexInYear\": 1,\n \"entityName\": \"Contoso\",\n \"entries\": [\n {\n \"indexInYear\": 57,\n \"indexInExport\": 1,\n \"agicapUniqueId\": \"f7f7ed5c-943c-4385-aa8d-145fd76b2fa1\", -- this is the id to use !\n \"name\": \"ACME Payment\",\n ... other fields omitted for brevity.\n }\n ]\n }\n</pre>",
"operationId": "MarkAsNotImported",
"parameters": [
{
"description": "Agicap entity identifier",
"example": 456897,
"in": "path",
"name": "entityId",
"required": true,
"schema": {
"format": "int32",
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/*+json": {
"example": {
"entriesNotImported": [
{
"entryAgicapUniqueId": "f7f7ed5c-943c-4385-aa8d-145fd76b2fa1",
"errors": [
{
"errorMessage": "1234 is not a val
# --- truncated at 32 KB (74 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/agicap/refs/heads/main/openapi/agicap-treasury-bank-journal-v1-openapi.json