Agicap Purchase Orders API
The Purchase Orders API from Agicap — 3 operation(s) for purchase orders.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/agicap-purchase-orders-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
contact: {}
title: Clients AR Account reports Purchase Orders API
version: v1
servers:
- url: https://api.agicap.com
- url: https://api.agicap.internal
tags:
- name: Purchase Orders
paths:
/public/business-documents/v1/entities/{entityid}/connections/{connectionid}/purchase-orders:
get:
operationId: PurchaseOrder_GetPurchaseOrders
parameters:
- description: Agicap entity unique identifier
in: path
name: entityid
required: true
schema:
description: Agicap entity unique identifier
type: string
- description: The connection unique identifier
in: path
name: connectionid
required: true
schema:
description: The connection unique identifier
format: uuid
type: string
- description: Number of items per page (max 10 000)
in: query
name: pagesize
schema:
description: Number of items per page (max 10 000)
format: int32
type: integer
- description: Page index
in: query
name: pageindex
schema:
description: Page index
format: int32
type: integer
- description: Unique identifier of the document in the data source
explode: false
in: query
name: externalids
schema:
description: Unique identifier of the document in the data source
items:
type: string
type: array
style: form
- description: Will return only documents updated **after** this date
in: query
name: updatedsince
schema:
description: Will return only documents updated **after** this date
format: date-time
type: string
- description: 'Filter on status. Possible values : draft, sent, accepted, refused, expired, partiallyinvoiced, invoiced, cancelled, deleted'
explode: false
in: query
name: status
schema:
description: 'Filter on status. Possible values : draft, sent, accepted, refused, expired, partiallyinvoiced, invoiced, cancelled, deleted'
items:
type: string
type: array
style: form
responses:
'200':
content:
application/json:
example:
items:
- amounts:
remainingAmount: 80
taxesAmount: 20
totalAmount: 200
counterParty:
id: id
name: counter party name
currency: EUR
deliveryDate: null
dueDate: '2025-03-07T14:30:10+00:00'
erpIdentificationFields:
erp field 1: value 1
erp field 2: value 2
externalId: Some External Id
id: d062b351-99ac-413a-9bf9-509498499a18
issueDate: '2024-02-06T14:30:10+00:00'
label: purchase order label
metadata:
additional field: additional info
purchaseOrderNumber: '00341001'
status: accepted
pagination:
pageIndex: 1
pageItemsCount: 7
pageSize: 10
totalItemsCount: 7
schema:
$ref: '#/components/schemas/PurchaseOrderDtoPageDto'
description: Purchase orders
'401':
description: Unauthorized request.
'403':
description: Forbidden request.
'429':
description: Too many requests. Please try again later.
'500':
content:
application/problem+json:
schema:
properties:
detail:
description: Details of the error
type:
- string
- 'null'
instance:
type:
- string
- 'null'
status:
description: Code status
type:
- integer
- 'null'
title:
description: Name of the error
type:
- string
- 'null'
type:
description: Type of error
type:
- string
- 'null'
type: object
description: An internal server occurred.
security:
- bearer_client_credentials:
- agicap:public-api
- bearer_client_credentials:
- agicap:public-api
- bearerAuth: []
summary: Get purchase orders
tags:
- Purchase Orders
post:
operationId: PurchaseOrder_CreatePurchaseOrders
parameters:
- description: Agicap entity unique identifier
in: path
name: entityid
required: true
schema:
description: Agicap entity unique identifier
type: string
- description: The connection unique identifier
in: path
name: connectionid
required: true
schema:
description: The connection unique identifier
format: uuid
type: string
requestBody:
content:
application/*+json:
example:
- amounts:
remainingAmount: 80
taxesAmount: 20
totalAmount: 200
counterParty:
id: id
name: counter party name
currency: EUR
deliveryDate: null
dueDate: '2025-03-07T14:30:10+00:00'
erpIdentificationFields:
erp field 1: value 1
erp field 2: value 2
externalId: Some External Id
issueDate: '2024-02-06T14:30:10+00:00'
label: purchase order label
metadata:
additional field: additional info
purchaseOrderNumber: '00341001'
status: accepted
schema:
items:
$ref: '#/components/schemas/CreatePurchaseOrderDto'
type: array
application/json:
example:
- amounts:
remainingAmount: 80
taxesAmount: 20
totalAmount: 200
counterParty:
id: id
name: counter party name
currency: EUR
deliveryDate: null
dueDate: '2025-03-07T14:30:10+00:00'
erpIdentificationFields:
erp field 1: value 1
erp field 2: value 2
externalId: Some External Id
issueDate: '2024-02-06T14:30:10+00:00'
label: purchase order label
metadata:
additional field: additional info
purchaseOrderNumber: '00341001'
status: accepted
schema:
items:
$ref: '#/components/schemas/CreatePurchaseOrderDto'
type: array
text/json:
example:
- amounts:
remainingAmount: 80
taxesAmount: 20
totalAmount: 200
counterParty:
id: id
name: counter party name
currency: EUR
deliveryDate: null
dueDate: '2025-03-07T14:30:10+00:00'
erpIdentificationFields:
erp field 1: value 1
erp field 2: value 2
externalId: Some External Id
issueDate: '2024-02-06T14:30:10+00:00'
label: purchase order label
metadata:
additional field: additional info
purchaseOrderNumber: '00341001'
status: accepted
schema:
items:
$ref: '#/components/schemas/CreatePurchaseOrderDto'
type: array
responses:
'201':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/CreatedDocumentDto'
type: array
description: Ids of the created documents, associated with the provided external identifiers
'401':
description: Unauthorized request.
'403':
description: Forbidden request.
'429':
description: Too many requests. Please try again later.
'500':
content:
application/problem+json:
schema:
properties:
detail:
description: Details of the error
type:
- string
- 'null'
instance:
type:
- string
- 'null'
status:
description: Code status
type:
- integer
- 'null'
title:
description: Name of the error
type:
- string
- 'null'
type:
description: Type of error
type:
- string
- 'null'
type: object
description: An internal server occurred.
security:
- bearer_client_credentials:
- agicap:public-api
- bearer_client_credentials:
- agicap:public-api
- bearerAuth: []
summary: Create purchase orders
tags:
- Purchase Orders
put:
operationId: PurchaseOrder_UpdatePurchaseOrders
parameters:
- description: Agicap entity unique identifier
in: path
name: entityid
required: true
schema:
description: Agicap entity unique identifier
type: string
- description: The connection unique identifier
in: path
name: connectionid
required: true
schema:
description: The connection unique identifier
format: uuid
type: string
requestBody:
content:
application/*+json:
schema:
items:
$ref: '#/components/schemas/UpdatePurchaseOrderDto'
type: array
application/json:
schema:
items:
$ref: '#/components/schemas/UpdatePurchaseOrderDto'
type: array
text/json:
schema:
items:
$ref: '#/components/schemas/UpdatePurchaseOrderDto'
type: array
responses:
'401':
description: Unauthorized request.
'403':
description: Forbidden request.
'429':
description: Too many requests. Please try again later.
'500':
content:
application/problem+json:
schema:
properties:
detail:
description: Details of the error
type:
- string
- 'null'
instance:
type:
- string
- 'null'
status:
description: Code status
type:
- integer
- 'null'
title:
description: Name of the error
type:
- string
- 'null'
type:
description: Type of error
type:
- string
- 'null'
type: object
description: An internal server occurred.
security:
- bearer_client_credentials:
- agicap:public-api
- bearer_client_credentials:
- agicap:public-api
- bearerAuth: []
summary: Update purchase orders
tags:
- Purchase Orders
/public/business-documents/v2/entities/{entityid}/connections/{connectionid}/purchase-orders:
get:
operationId: PurchaseOrder_GetPurchaseOrdersV2
parameters:
- description: Agicap entity unique identifier
in: path
name: entityid
required: true
schema:
description: Agicap entity unique identifier
type: string
- description: The connection unique identifier
in: path
name: connectionid
required: true
schema:
description: The connection unique identifier
format: uuid
type: string
- description: Number of items per page (max 10 000)
in: query
name: pagesize
schema:
description: Number of items per page (max 10 000)
format: int32
type: integer
- description: Page index
in: query
name: pageindex
schema:
description: Page index
format: int32
type: integer
- description: Unique identifier of the document in the data source
explode: false
in: query
name: externalids
schema:
description: Unique identifier of the document in the data source
items:
type: string
type: array
style: form
- description: Will return only documents updated **after** this date
in: query
name: updatedsince
schema:
description: Will return only documents updated **after** this date
format: date-time
type: string
- description: 'Filter on status. Possible values : draft, sent, accepted, refused, expired, partiallyinvoiced, invoiced, cancelled, deleted'
explode: false
in: query
name: status
schema:
description: 'Filter on status. Possible values : draft, sent, accepted, refused, expired, partiallyinvoiced, invoiced, cancelled, deleted'
items:
type: string
type: array
style: form
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PurchaseOrderDtoV2PageDto'
description: Purchase orders
'401':
description: Unauthorized request.
'403':
description: Forbidden request.
'429':
description: Too many requests. Please try again later.
'500':
content:
application/problem+json:
schema:
properties:
detail:
description: Details of the error
type:
- string
- 'null'
instance:
type:
- string
- 'null'
status:
description: Code status
type:
- integer
- 'null'
title:
description: Name of the error
type:
- string
- 'null'
type:
description: Type of error
type:
- string
- 'null'
type: object
description: An internal server occurred.
security:
- bearer_client_credentials:
- agicap:public-api
- bearer_client_credentials:
- agicap:public-api
- bearerAuth: []
summary: Get purchase orders
tags:
- Purchase Orders
post:
operationId: PurchaseOrder_CreatePurchaseOrdersV2
parameters:
- description: Agicap entity unique identifier
in: path
name: entityid
required: true
schema:
description: Agicap entity unique identifier
type: string
- description: The connection unique identifier
in: path
name: connectionid
required: true
schema:
description: The connection unique identifier
format: uuid
type: string
requestBody:
content:
application/*+json:
example:
- amounts:
remainingAmount: 80
taxesAmount: 20
totalAmount: 200
counterParty:
id: id
name: counter party name
currency: EUR
deliveryDate: null
dueDate: '2025-03-07T14:30:10+00:00'
erpIdentificationFields:
erp field 1: value 1
erp field 2: value 2
externalId: Some External Id
issueDate: '2024-02-06T14:30:10+00:00'
label: purchase order label
lineItems: null
metadata:
additional field: additional info
purchaseOrderNumber: '00341001'
status: accepted
schema:
items:
$ref: '#/components/schemas/CreatePurchaseOrderDtoV2'
type: array
application/json:
example:
- amounts:
remainingAmount: 80
taxesAmount: 20
totalAmount: 200
counterParty:
id: id
name: counter party name
currency: EUR
deliveryDate: null
dueDate: '2025-03-07T14:30:10+00:00'
erpIdentificationFields:
erp field 1: value 1
erp field 2: value 2
externalId: Some External Id
issueDate: '2024-02-06T14:30:10+00:00'
label: purchase order label
lineItems: null
metadata:
additional field: additional info
purchaseOrderNumber: '00341001'
status: accepted
schema:
items:
$ref: '#/components/schemas/CreatePurchaseOrderDtoV2'
type: array
text/json:
example:
- amounts:
remainingAmount: 80
taxesAmount: 20
totalAmount: 200
counterParty:
id: id
name: counter party name
currency: EUR
deliveryDate: null
dueDate: '2025-03-07T14:30:10+00:00'
erpIdentificationFields:
erp field 1: value 1
erp field 2: value 2
externalId: Some External Id
issueDate: '2024-02-06T14:30:10+00:00'
label: purchase order label
lineItems: null
metadata:
additional field: additional info
purchaseOrderNumber: '00341001'
status: accepted
schema:
items:
$ref: '#/components/schemas/CreatePurchaseOrderDtoV2'
type: array
responses:
'201':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/CreatedDocumentDto'
type: array
description: Ids of the created documents, associated with the provided external identifiers
'401':
description: Unauthorized request.
'403':
description: Forbidden request.
'429':
description: Too many requests. Please try again later.
'500':
content:
application/problem+json:
schema:
properties:
detail:
description: Details of the error
type:
- string
- 'null'
instance:
type:
- string
- 'null'
status:
description: Code status
type:
- integer
- 'null'
title:
description: Name of the error
type:
- string
- 'null'
type:
description: Type of error
type:
- string
- 'null'
type: object
description: An internal server occurred.
security:
- bearer_client_credentials:
- agicap:public-api
- bearer_client_credentials:
- agicap:public-api
- bearerAuth: []
summary: Create purchase orders
tags:
- Purchase Orders
put:
operationId: PurchaseOrder_UpdatePurchaseOrdersV2
parameters:
- description: Agicap entity unique identifier
in: path
name: entityid
required: true
schema:
description: Agicap entity unique identifier
type: string
- description: The connection unique identifier
in: path
name: connectionid
required: true
schema:
description: The connection unique identifier
format: uuid
type: string
requestBody:
content:
application/*+json:
example:
- amounts:
remainingAmount: 80
taxesAmount: 20
totalAmount: 200
counterParty:
id: id
name: counter party name
currency: EUR
deliveryDate: null
dueDate: '2025-03-07T14:30:10+00:00'
erpIdentificationFields:
erp field 1: value 1
erp field 2: value 2
externalId: Some External Id
id: d062b351-99ac-413a-9bf9-509498499a18
issueDate: '2024-02-06T14:30:10+00:00'
label: purchase order label
lineItems: null
metadata:
additional field: additional info
purchaseOrderNumber: '00341001'
status: accepted
schema:
items:
$ref: '#/components/schemas/UpdatePurchaseOrderDtoV2'
type: array
application/json:
example:
- amounts:
remainingAmount: 80
taxesAmount: 20
totalAmount: 200
counterParty:
id: id
name: counter party name
currency: EUR
deliveryDate: null
dueDate: '2025-03-07T14:30:10+00:00'
erpIdentificationFields:
erp field 1: value 1
erp field 2: value 2
externalId: Some External Id
id: d062b351-99ac-413a-9bf9-509498499a18
issueDate: '2024-02-06T14:30:10+00:00'
label: purchase order label
lineItems: null
metadata:
additional field: additional info
purchaseOrderNumber: '00341001'
status: accepted
schema:
items:
$ref: '#/components/schemas/UpdatePurchaseOrderDtoV2'
type: array
text/json:
example:
- amounts:
remainingAmount: 80
taxesAmount: 20
totalAmount: 200
counterParty:
id: id
name: counter party name
currency: EUR
deliveryDate: null
dueDate: '2025-03-07T14:30:10+00:00'
erpIdentificationFields:
erp field 1: value 1
erp field 2: value 2
externalId: Some External Id
id: d062b351-99ac-413a-9bf9-509498499a18
issueDate: '2024-02-06T14:30:10+00:00'
label: purchase order label
lineItems: null
metadata:
additional field: additional info
purchaseOrderNumber: '00341001'
status: accepted
schema:
items:
$ref: '#/components/schemas/UpdatePurchaseOrderDtoV2'
type: array
responses:
'401':
description: Unauthorized request.
'403':
description: Forbidden request.
'429':
description: Too many requests. Please try again later.
'500':
content:
application/problem+json:
schema:
properties:
detail:
description: Details of the error
type:
- string
- 'null'
instance:
type:
- string
- 'null'
status:
description: Code status
type:
- integer
- 'null'
title:
description: Name of the error
type:
- string
- 'null'
type:
description: Type of error
type:
- string
- 'null'
type: object
description: An internal server occurred.
security:
- bearer_client_credentials:
- agicap:public-api
- bearer_client_credentials:
- agicap:public-api
- bearerAuth: []
summary: Update purchase orders
tags:
- Purchase Orders
/public/invoices-management/v1/entities/{entityId}/purchase-orders:
post:
description: 'Use this endpoint to retrieve the full details of purchase orders linked to invoices, from a list of purchase order IDs. It returns header information, order and delivery statuses, line items with ordered, delivered and billed quantities, and the list of associated delivery notes.
This data is typically used alongside the invoice export to provide ERPs with the delivery references needed to finalize the 3-way matching and close orders upon invoice creation.'
operationId: post_public-api/invoices-management/v1/entities/{entityid}/purchase-orders
parameters:
- description: The entity identifier.
in: path
name: entityId
required: true
schema:
format: int32
type: integer
requestBody:
content:
application/*+json:
schema:
allOf:
- $ref: '#/components/schemas/InvoicesManagement.Web.Controllers.PublicApi.Dto.PurchaseOrderQueryDto'
application/json:
schema:
allOf:
- $ref: '#/components/schemas/InvoicesManagement.Web.Controllers.PublicApi.Dto.PurchaseOrderQueryDto'
text/json:
schema:
allOf:
- $ref: '#/components/schemas/InvoicesManagement.Web.Controllers.PublicApi.Dto.PurchaseOrderQueryDto'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/InvoicesManagement.Web.Controllers.PublicApi.Responses.PurchaseOrdersResponse'
description: Your request has been successfully processed.
'400':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
description: Your request is invalid.
'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/Microsoft.AspNetCore.Mvc.ProblemDetails'
description: An internal server occurred.
security:
- bearerAuth: []
summary: List purchase orders
tags:
- Purchase Orders
components:
schemas:
UpdatePurchaseOrderDtoV2:
additionalProperties: false
properties:
amounts:
$ref: '#/components/schemas/AmountsWithRemainingAmountDtoV2'
counterParty:
$ref: '#/components/schemas/CounterPartyDtoV2'
currency:
description: Currency code in ISO 4217 format
minLength: 1
type: string
deliveryDate:
description: Delivery date in ISO 8601 format
format: date-time
type:
- string
- 'null'
dueDate:
description: Due date in ISO 8601 format
format: date-time
type: string
erpIdentificationFields:
additionalProperties:
type: string
type:
- object
- 'null'
externalId:
description: Unique identifier of the document in the source data
minLength: 1
type: string
id:
description: Unique identifier generated by Agicap
format: uuid
type: string
issueDate:
description: Issue date in ISO 8601 format
format: date-time
type: string
label:
description: Label of the order
type:
- string
- 'null'
lineItems:
description: Article line items of the purchase order. Optional.
items:
$ref: '#/components/schemas/PurchaseOrderLineItemDto'
type:
- array
- 'null'
metadata:
additionalProperties:
type: string
description: Additional metadata as a JSON Object
type:
- object
- 'null'
purchaseOrderNumber:
description: Document number in the source data
minLength: 1
type: string
status:
description: 'Possible values : draft, sent, accepted, refused, expired, partiallyinvoiced, invoiced, cancelled, deleted'
minLength: 1
type: string
required:
- amounts
- counterParty
- currency
- dueDate
- externalId
- id
- issueDate
- purchaseOrderNumber
- status
title: UpdatePurchaseOrder
type: object
AmountsWithRemainingAmountDto:
additionalProperties: false
properties:
remainingAmount:
description: Remaining amount in the document currency.
format: double
type:
- number
- 'null'
taxesAmount:
description: Taxes amount in the document currency
format: double
type:
- number
- 'null'
totalAmount:
description: Total amount in the document currency.
format: double
type: number
required:
- totalAmount
title: AmountsWithRemainingAmount
type: object
InvoicesManagement.Web.Controllers.PublicApi.Responses.PurchaseOrderLineItemResponse:
additionalProperties: false
description: Purchase order line item details.
properties:
articleName:
description: The article name.
type:
- string
- 'null'
articleReference:
description: The article reference.
type:
- string
- 'null'
billedQuantity:
description: The billed quantity.
format: double
type: number
deliveredQuantity:
description: The delivered quantity.
format: double
type: number
erpId:
description: The line item ERP identifier.
type:
- string
- 'null'
lineItemId:
description: The line item identifier.
format: uuid
type: string
orderedQuantity:
description: The ordered quantity.
format: double
type:
- number
- 'null'
totalAmountExcludingTaxes:
description: The total amount excluding tax
# --- truncated at 32 KB (52 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/agicap/refs/heads/main/openapi/agicap-purchase-orders-api-openapi.yml