| Authentication | ||
|---|---|---|
| Method | Endpoint | Description |
| POST | /api/v1/Authentication | Authenticates credentials and grants access token |
| ExternalBatch | ||
|---|---|---|
| Method | Endpoint | Description |
| GET | /api/v1/ExternalBatch | Returns a list of external batches |
| GET | /api/v1/ExternalBatch/{ExternalBatchRef}/Status | Returns the status of an external batch |
| POST | /api/v1/ExternalBatch | Creates an external batch within an import group |
| PUT | /api/v1/ExternalBatch/{ExternalBatchRef}/Status/{BatchStatus} | Sets the status of an external batch |
| PUT | /api/v1/ExternalBatch/{ExternalBatchRef}/Status/MarkReadyForImport | Sets an external batch to "Ready for Import" status |
| DELETE | /api/v1/ExternalBatch/{ExternalBatchRef} | Deletes an external batch |
| ExternalDocument | ||
|---|---|---|
| Method | Endpoint | Description |
| GET | /api/v1/ExternalDocument/{ExternalDocumentRef} | Returns external document details and external document bytes |
| GET | /api/v1/ExternalBatch/{ExternalBatchRef}/ExternalDocument | Returns a list of external documents in an external batch |
| GET | /api/v1/ExternalBatch/{ExternalBatchRef}/ExternalDocument/{ExternalDocumentRef} | Returns external document details and external document bytes |
| POST | /api/v1/ExternalBatch/{ExternalBatchRef}/ExternalDocument | Adds a document to an external batch |
| DELETE | /api/v1/ExternalBatch/{ExternalBatchRef}/ExternalDocument/{ExternalDocumentRef} | Deletes a document from an external batch |
| ImportGroup | ||
|---|---|---|
| Method | Endpoint | Description |
| GET | /api/v1/ImportGroup | Gets import group list |
| POST | /api/v1/ImportGroup | Creates an import group |
| DELETE | /api/v1/ImportGroup | Deletes an import group |