Depending on your business scenarios and the Basware systems you have in use, you will be using different Basware APIs to support your business. Here are the APIs typically used by our clients in some of the common business scenarios.
Business scenarios:
| Use case / API name | Purpose | Remarks |
| Transfer approved invoices to accounting (link) |
||
| GET accountingDocuments | Transfer invoices approved for payment to accounting system | |
| POST accountingDocuments/acknowledge | Mark invoice as fetched | |
| POST accountingDocuments/prebookResponse | Mark invoice as prebooked in accounting system | Only when prebooking is used |
| POST accountingDocuments/transferResponse | Mark invoice as transferred to accounting system | |
| POST accountingDocuments/paymentResponse | Update invoice payment date | Required with Basware Analytics |
| (Endpoint to receive push notifications) | Receive push notifications for new documents. | Only when using push notifications. |
| Import master data (link) |
||
| POST accounts | Import accounts from ERP | |
| POST costCenters | Import cost centers from ERP | |
| POST vendors | Import vendors from ERP | |
| POST genericLists | Import additional coding dimensions from ERP | Supports multiple dimensions, not generally used in all projects |
| POST exchangeRates | Import exchange rated | Not generally used in all projects |
| POST paymentTerms | Import payment terms from ERP | Not generally used in all projects |
| POST taxCodes | Import tax codes from ERP | Not generally used in all projects |
| POST advancedValidations | Import invoice coding row validation rules from ERP | Not generally used in all projects |
| Import users (link) |
||
| POST applicationGroups | Control per-application log-in access (assigned to users). | One-time set-up required if using users API. |
| POST users | Import users | Not generally used in all projects |
| POST advancedPermissions | Import user approval rights information | Not generally used in all projects |
| OAUTH2 authentication (link) | ||
| GET tokens | Retrieve OAUTH2 access tokens | When using OAUTH2 authentication |
| Error handling (link) |
||
| GET requestStatus | Error handling | Returns errors asynchronously from Basware target systems |
In addition to the APIs listed in the "Integrating to Basware AP Automation for accounts payable processing" section, you will need:
| Use case / API name | Purpose | Remarks |
| Import external matching orders (link) |
||
| POST matchingOrders | Import order header data | |
| POST matchingOrderLines | Import order lines and goods receipts | |
| PATCH matchingOrderLines | Add goods receipts to order lines when source system(s) cannot send both GRs and order lines in a single request. | Optional |
See network API guide for more details.
| Use case / API name | Purpose | Remarks |
| POST invoices | Send electronic invoices | |
| POST creditNotes | Send electronic credit notes | |
| POST files | Add attachments to invoices / credit notes | File(s) need to be posted before the related invoice |
| GET notifications | Status notifications and error handling | |
| DELETE notifications | Remove received notifications |
See network API guide for more details.
| Use case / API name | Purpose | Remarks |
| GET notifications | Get list of invoice ID's to fetch | |
| GET invoices | Receive electronic invoices | |
| GET creditNotes | Receive electronic credit notes | |
| GET files | Receive attachments to invoices / credit notes | |
| POST notifications | Post invoice status notifications | |
| DELETE notifications | Remove processed notifications |
| Use case / API name | Purpose | Remarks |
| POST vendors | Import vendors from ERP | In "P2P APIs" |
| GET notifications | List vendor ID's proposed for changes in ERP | In "Network APIs" |
| GET vendorDetails | Get vendor changes to ERP for approval | API documentation currently not available online |
| DELETE notifications | Remove vendor ID's previously proposed for change in ERP | In "Network APIs" |
| POST companies | Import companies | In "P2P APIs". Not generally used in most projects. |
| GET requestStatus | Error handling for vendors API | In "P2P APIs". Not generally used in most projects. |
| OAUTH2 authentication (link) | ||
| GET tokens | Retrieve OAUTH2 access tokens for vendors and companies APIs | When using OAUTH2 authentication |
In addition to APIs in "Accounts payable processing" section, some of the following APIs are used depending on which parts of purchasing process are done in Basware P2P Purchase and which parts are done in external purchasing system. See P2P API manual for more details.
| Use case / API name | Purpose | Remarks |
| Import data | ||
| POST purchaseRequisitions | Import purchase requisitions to P2P Purchase | |
| POST purchaseOrders | Import purchase orders to P2P Purchase | |
| POST goodsReceipts | Import goods receipts to P2P Purchase | |
| POST contracts | Import contracts to P2P Purchase | |
| Export data | ||
| GET exportedPurchaseOrders | Export order with goods receipts from P2P purchase | Data is refreshed when order status updates |
| GET exportedPurchaseRequisitions | Export purchase requisition from P2P purchase | Data is refreshed when requisition is compeleted. |
| GET exportedContracts | Export contracts from P2P Purchase | |
| GET exportedContractSpends | Export contract spends from P2P Purchase | |
| Error handling | ||
| GET requestStatus | Error handling | Returns errors asynchronously from Basware target systems. |
| Use case / API name | Purpose | Remarks |
| POST vendors | Import vendors from ERP | |
| POST contracts | Import contracts from external purchasing system | |
| GET exportedContracts | Export contracts from Basware P2P | |
| Error handling (link) |
||
| GET requestStatus | Error handling | Returns errors asynchronously from Basware target systems |
| OAUTH2 authentication (link) | ||
| GET tokens | Retrieve OAUTH2 access tokens | When using OAUTH2 authentication |
See sections "Accounts payable processing" and "Sending e-invoices to your Customers".
It is possible to import user(s) to any of the following Basware applications: Purchase-To-Pay (P2P), Supplier portal (network), Supplier Management (network), Network, CloudScan 3.0 (available Q1/2021). User data can be either imported through integrations or maintained manually.
| Use case / API name | Purpose | Remarks |
| Import users (link) |
||
| POST applicationGroups | Control per-application log-in access (assigned to users). | One-time set-up required for using users API. Typically this set-up is done manually. |
| POST users | Import users | |
| POST advancedPermissions | Import user approval rights information | Allows importing coding row level approval limits for users. |
| OAUTH2 authentication (link) | ||
| GET tokens | Retrieve OAUTH2 access tokens | When using OAUTH2 authentication |
| Error handling (link) |
||
| GET requestStatus | Error handling | Returns errors asynchronously from Basware target systems |
