Agicap Purchase-to-Pay (v1)
Use APIs to export supplier documents or update them in Agicap from an external source.
OpenAPI Specification
{
"components": {
"schemas": {
"Event.CreditNoteApprovedNotification": {
"additionalProperties": false,
"properties": {
"creditNoteId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"creditNoteId"
],
"type": "object"
},
"Event.CreditNoteHasDataToVerifyNotification": {
"additionalProperties": false,
"properties": {
"creditNoteId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"creditNoteId"
],
"type": "object"
},
"Event.DocumentRecognizedNotification": {
"additionalProperties": false,
"properties": {
"documentId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"documentId"
],
"type": "object"
},
"Event.InvoiceMarkedAsDisputedNotification": {
"additionalProperties": false,
"properties": {
"invoiceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"invoiceId"
],
"type": "object"
},
"Event.InvoiceMarkedAsRefusedNotification": {
"additionalProperties": false,
"properties": {
"invoiceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"invoiceId"
],
"type": "object"
},
"Event.InvoiceMarkedAsToDeleteNotification": {
"additionalProperties": false,
"properties": {
"invoiceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"invoiceId"
],
"type": "object"
},
"Event.InvoiceMarkedAsToVerifyNotification": {
"additionalProperties": false,
"properties": {
"invoiceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"invoiceId"
],
"type": "object"
},
"Event.InvoiceMarkedAsVerifiedNotification": {
"additionalProperties": false,
"properties": {
"invoiceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"invoiceId"
],
"type": "object"
},
"InvoicesManagement.Read.Export.InvoiceStatusForExport": {
"additionalProperties": false,
"enum": [
"Verified",
"NotVerified"
],
"type": "string"
},
"InvoicesManagement.Read.Export.PurchaseOrderStatusForExport": {
"additionalProperties": false,
"enum": [
"Open",
"Closed"
],
"type": "string"
},
"InvoicesManagement.Shared.App.Ports.FileExtension": {
"additionalProperties": false,
"enum": [
"Jpg",
"Pdf",
"Png",
"Xml",
"Unknown"
],
"type": "string"
},
"InvoicesManagement.Shared.App.PurchaseDocumentType": {
"additionalProperties": false,
"enum": [
"Invoice",
"CreditNote",
"PurchaseOrder",
"Delivery"
],
"type": "string"
},
"InvoicesManagement.Web.Controllers.PublicApi.Dto.InvoiceQueryDto": {
"additionalProperties": false,
"properties": {
"invoiceIds": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
},
"required": [
"invoiceIds"
],
"type": "object"
},
"InvoicesManagement.Web.Controllers.PublicApi.Dto.MarkInvoicesAsVerifiedDto": {
"additionalProperties": false,
"properties": {
"invoiceIds": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
},
"required": [
"invoiceIds"
],
"type": "object"
},
"InvoicesManagement.Web.Controllers.PublicApi.Dto.PurchaseOrderQueryDto": {
"additionalProperties": false,
"properties": {
"purchaseOrderIds": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
},
"required": [
"purchaseOrderIds"
],
"type": "object"
},
"InvoicesManagement.Web.Controllers.PublicApi.Responses.InboxDocumentResponse": {
"additionalProperties": false,
"description": "An inbox document with a temporary download link to its attached file.",
"properties": {
"agicapDocumentId": {
"description": "The Agicap document identifier, used to later change the document's status.",
"format": "uuid",
"type": "string"
},
"extension": {
"allOf": [
{
"$ref": "#/components/schemas/InvoicesManagement.Shared.App.Ports.FileExtension"
}
],
"description": "The attached file extension (Pdf, Jpg, Png, ...); null when it could not be determined.",
"nullable": true
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/InvoicesManagement.Shared.App.PurchaseDocumentType"
}
],
"description": "The document type (Invoice, CreditNote)."
},
"url": {
"description": "A temporary, time-limited URL to download the document's attached file.",
"type": "string"
}
},
"required": [
"agicapDocumentId",
"type",
"url"
],
"type": "object"
},
"InvoicesManagement.Web.Controllers.PublicApi.Responses.InboxDocumentsPaginationResponse": {
"additionalProperties": false,
"description": "Pagination details for a page of inbox documents.",
"properties": {
"currentPageItemsCount": {
"description": "The number of documents returned on this page.",
"format": "int32",
"type": "integer"
},
"currentPageNumber": {
"description": "The zero-based index of this page.",
"format": "int32",
"type": "integer"
},
"pageSize": {
"description": "The maximum number of documents per page.",
"format": "int32",
"type": "integer"
},
"pagesCount": {
"description": "The total number of pages.",
"format": "int32",
"type": "integer"
},
"totalItemsCount": {
"description": "The total number of exportable documents in the inbox.",
"format": "int32",
"type": "integer"
}
},
"required": [
"currentPageItemsCount",
"currentPageNumber",
"pagesCount",
"pageSize",
"totalItemsCount"
],
"type": "object"
},
"InvoicesManagement.Web.Controllers.PublicApi.Responses.InboxDocumentsResponse": {
"additionalProperties": false,
"description": "A page of inbox documents with temporary download links.",
"properties": {
"documents": {
"description": "The exportable inbox documents on this page.",
"items": {
"$ref": "#/components/schemas/InvoicesManagement.Web.Controllers.PublicApi.Responses.InboxDocumentResponse"
},
"type": "array"
},
"pagination": {
"allOf": [
{
"$ref": "#/components/schemas/InvoicesManagement.Web.Controllers.PublicApi.Responses.InboxDocumentsPaginationResponse"
}
],
"description": "Pagination details for this page."
}
},
"required": [
"documents",
"pagination"
],
"type": "object"
},
"InvoicesManagement.Web.Controllers.PublicApi.Responses.InvoiceLineItemResponse": {
"additionalProperties": false,
"description": "Invoice line item details.",
"properties": {
"articleName": {
"description": "The article name.",
"nullable": true,
"type": "string"
},
"articleReference": {
"description": "The article reference.",
"nullable": true,
"type": "string"
},
"lineItemId": {
"description": "The line item identifier.",
"format": "uuid",
"type": "string"
},
"purchaseOrderId": {
"description": "The linked purchase order identifier.",
"format": "uuid",
"nullable": true,
"type": "string"
},
"purchaseOrderLineItemId": {
"description": "The linked purchase order line item identifier.",
"format": "uuid",
"nullable": true,
"type": "string"
},
"quantity": {
"description": "The quantity.",
"format": "double",
"nullable": true,
"type": "number"
},
"totalAmountExcludingTaxes": {
"description": "The total amount excluding taxes.",
"format": "double",
"nullable": true,
"type": "number"
},
"unitAmountExcludingTaxes": {
"description": "The unit amount excluding taxes.",
"format": "double",
"nullable": true,
"type": "number"
}
},
"required": [
"lineItemId"
],
"type": "object"
},
"InvoicesManagement.Web.Controllers.PublicApi.Responses.InvoiceLinkedPurchaseOrderResponse": {
"additionalProperties": false,
"description": "Purchase order linked to an invoice.",
"properties": {
"associatedAmountExcludingTaxes": {
"description": "The amount excluding taxes associated to this invoice.",
"format": "double",
"type": "number"
},
"number": {
"description": "The purchase order number.",
"nullable": true,
"type": "string"
},
"purchaseOrderId": {
"description": "The purchase order identifier.",
"format": "uuid",
"type": "string"
}
},
"required": [
"associatedAmountExcludingTaxes",
"purchaseOrderId"
],
"type": "object"
},
"InvoicesManagement.Web.Controllers.PublicApi.Responses.InvoiceResponse": {
"additionalProperties": false,
"description": "Invoice details.",
"properties": {
"billingDate": {
"description": "The billing date.",
"format": "date",
"nullable": true,
"type": "string"
},
"costCenter": {
"description": "The cost center name.",
"nullable": true,
"type": "string"
},
"currency": {
"description": "The currency code (ISO 4217).",
"nullable": true,
"type": "string"
},
"dueDate": {
"description": "The due date.",
"format": "date",
"nullable": true,
"type": "string"
},
"invoiceId": {
"description": "The invoice identifier.",
"format": "uuid",
"type": "string"
},
"lineItems": {
"description": "The invoice line items.",
"items": {
"$ref": "#/components/schemas/InvoicesManagement.Web.Controllers.PublicApi.Responses.InvoiceLineItemResponse"
},
"type": "array"
},
"linkedPurchaseOrders": {
"description": "The linked purchase orders.",
"items": {
"$ref": "#/components/schemas/InvoicesManagement.Web.Controllers.PublicApi.Responses.InvoiceLinkedPurchaseOrderResponse"
},
"type": "array"
},
"natures": {
"description": "The nature names.",
"items": {
"type": "string"
},
"type": "array"
},
"number": {
"description": "The invoice number.",
"nullable": true,
"type": "string"
},
"originalAmountExcludingTaxes": {
"description": "The original amount excluding taxes.",
"format": "double",
"nullable": true,
"type": "number"
},
"originalAmountIncludingTaxes": {
"description": "The original amount including taxes.",
"format": "double",
"nullable": true,
"type": "number"
},
"paymentMethod": {
"description": "The payment method.",
"nullable": true,
"type": "string"
},
"reference": {
"description": "The invoice reference.",
"nullable": true,
"type": "string"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/InvoicesManagement.Read.Export.InvoiceStatusForExport"
}
],
"description": "The invoice status (Verified, NotVerified)."
},
"supplier": {
"description": "The supplier name.",
"nullable": true,
"type": "string"
},
"title": {
"description": "The invoice title.",
"type": "string"
}
},
"required": [
"invoiceId",
"lineItems",
"linkedPurchaseOrders",
"natures",
"status",
"title"
],
"type": "object"
},
"InvoicesManagement.Web.Controllers.PublicApi.Responses.InvoicesResponse": {
"additionalProperties": false,
"description": "Invoices response.",
"properties": {
"invoices": {
"description": "The list of invoices.",
"items": {
"$ref": "#/components/schemas/InvoicesManagement.Web.Controllers.PublicApi.Responses.InvoiceResponse"
},
"type": "array"
}
},
"required": [
"invoices"
],
"type": "object"
},
"InvoicesManagement.Web.Controllers.PublicApi.Responses.MarkInvoicesAsVerifiedError": {
"additionalProperties": false,
"description": "Invoice verification error",
"properties": {
"exception": {
"description": "The exception type",
"type": "string"
},
"message": {
"description": "The error message",
"type": "string"
}
},
"required": [
"exception",
"message"
],
"type": "object"
},
"InvoicesManagement.Web.Controllers.PublicApi.Responses.MarkInvoicesAsVerifiedResponse": {
"additionalProperties": false,
"description": "Invoices verification report",
"properties": {
"results": {
"description": "The result",
"items": {
"$ref": "#/components/schemas/InvoicesManagement.Web.Controllers.PublicApi.Responses.MarkInvoicesAsVerifiedResult"
},
"type": "array"
}
},
"required": [
"results"
],
"type": "object"
},
"InvoicesManagement.Web.Controllers.PublicApi.Responses.MarkInvoicesAsVerifiedResult": {
"additionalProperties": false,
"description": "Invoice verification result",
"properties": {
"error": {
"allOf": [
{
"$ref": "#/components/schemas/InvoicesManagement.Web.Controllers.PublicApi.Responses.MarkInvoicesAsVerifiedError"
}
],
"description": "The error, is any",
"nullable": true
},
"invoiceId": {
"description": "The invoice identifier",
"format": "uuid",
"type": "string"
},
"success": {
"description": "Is success",
"type": "boolean"
}
},
"required": [
"invoiceId",
"success"
],
"type": "object"
},
"InvoicesManagement.Web.Controllers.PublicApi.Responses.PurchaseOrderDeliveryResponse": {
"additionalProperties": false,
"description": "Purchase order delivery details.",
"properties": {
"date": {
"description": "The delivery date.",
"format": "date",
"type": "string"
},
"number": {
"description": "The delivery number.",
"nullable": true,
"type": "string"
}
},
"required": [
"date"
],
"type": "object"
},
"InvoicesManagement.Web.Controllers.PublicApi.Responses.PurchaseOrderLineItemResponse": {
"additionalProperties": false,
"description": "Purchase order line item details.",
"properties": {
"articleName": {
"description": "The article name.",
"nullable": true,
"type": "string"
},
"articleReference": {
"description": "The article reference.",
"nullable": true,
"type": "string"
},
"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.",
"nullable": true,
"type": "string"
},
"lineItemId": {
"description": "The line item identifier.",
"format": "uuid",
"type": "string"
},
"orderedQuantity": {
"description": "The ordered quantity.",
"format": "double",
"nullable": true,
"type": "number"
},
"totalAmountExcludingTaxes": {
"description": "The total amount excluding taxes.",
"format": "double",
"nullable": true,
"type": "number"
},
"unitAmountExcludingTaxes": {
"description": "The unit amount excluding taxes.",
"format": "double",
"nullable": true,
"type": "number"
}
},
"required": [
"billedQuantity",
"deliveredQuantity",
"lineItemId"
],
"type": "object"
},
"InvoicesManagement.Web.Controllers.PublicApi.Responses.PurchaseOrderLinkedInvoiceResponse": {
"additionalProperties": false,
"description": "Invoice linked to a purchase order.",
"properties": {
"associatedAmountExcludingTaxes": {
"description": "The amount excluding taxes associated to this purchase order.",
"format": "double",
"type": "number"
},
"invoiceId": {
"description": "The invoice identifier.",
"format": "uuid",
"type": "string"
},
"number": {
"description": "The invoice number.",
"nullable": true,
"type": "string"
}
},
"required": [
"associatedAmountExcludingTaxes",
"invoiceId"
],
"type": "object"
},
"InvoicesManagement.Web.Controllers.PublicApi.Responses.PurchaseOrderResponse": {
"additionalProperties": false,
"description": "Purchase order details.",
"properties": {
"amountExcludingTaxes": {
"description": "The amount excluding taxes.",
"format": "double",
"nullable": true,
"type": "number"
},
"amountIncludingTaxes": {
"description": "The amount including taxes.",
"format": "double",
"nullable": true,
"type": "number"
},
"counterpartyId": {
"description": "The counterparty (supplier) ERP identifier, when synced from the P2P integration; null until the purchase order is re-synced.",
"nullable": true,
"type": "string"
},
"counterpartyName": {
"description": "The counterparty (supplier) name as synced from the P2P integration; null until the purchase order is re-synced. Distinct from the collection-context Supplier name.",
"nullable": true,
"type": "string"
},
"currency": {
"description": "The currency code (ISO 4217).",
"nullable": true,
"type": "string"
},
"deliveries": {
"description": "The deliveries.",
"items": {
"$ref": "#/components/schemas/InvoicesManagement.Web.Controllers.PublicApi.Responses.PurchaseOrderDeliveryResponse"
},
"type": "array"
},
"deliveryDate": {
"description": "The delivery date.",
"format": "date",
"nullable": true,
"type": "string"
},
"deliveryStatus": {
"description": "The delivery status.",
"type": "string"
},
"expectedPaymentDate": {
"description": "The expected payment date.",
"format": "date",
"nullable": true,
"type": "string"
},
"lineItems": {
"description": "The line items.",
"items": {
"$ref": "#/components/schemas/InvoicesManagement.Web.Controllers.PublicApi.Responses.PurchaseOrderLineItemResponse"
},
"type": "array"
},
"linkedInvoices": {
"description": "The linked invoices.",
"items": {
"$ref": "#/components/schemas/InvoicesManagement.Web.Controllers.PublicApi.Responses.PurchaseOrderLinkedInvoiceResponse"
},
"type": "array"
},
"number": {
"description": "The purchase order number.",
"nullable": true,
"type": "string"
},
"purchaseOrderId": {
"description": "The purchase order identifier.",
"format": "uuid",
"type": "string"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/InvoicesManagement.Read.Export.PurchaseOrderStatusForExport"
}
],
"description": "The purchase order status (Open, Closed)."
},
"supplier": {
"description": "The supplier name.",
"nullable": true,
"type": "string"
},
"title": {
"description": "The purchase order title.",
"type": "string"
}
},
"required": [
"deliveries",
"deliveryStatus",
"lineItems",
"linkedInvoices",
"purchaseOrderId",
"status",
"title"
],
"type": "object"
},
"InvoicesManagement.Web.Controllers.PublicApi.Responses.PurchaseOrdersResponse": {
"additionalProperties": false,
"description": "Purchase orders response.",
"properties": {
"purchaseOrders": {
"description": "The list of purchase orders.",
"items": {
"$ref": "#/components/schemas/InvoicesManagement.Web.Controllers.PublicApi.Responses.PurchaseOrderResponse"
},
"type": "array"
}
},
"required": [
"purchaseOrders"
],
"type": "object"
},
"Microsoft.AspNetCore.Mvc.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": {
"enum": [
"Generic_InternalServerError",
"InvoicesZipDownloadError",
"Read_Generic_Error",
"Write_File_InvalidData",
"Write_File_InvalidFormat",
"Write_Invoice_Duplicate",
"Write_Invoice_EmptyFile",
"Write_Invoice_NotSupportedFileType",
"Write_Invoice_TooLargeFile",
"Write_Invoice_Uncompleted",
"Write_Supplier_NotFound"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
},
"securitySchemes": {
"Bearer": {
"scheme": "Bearer",
"type": "http"
},
"bearerAuth": {
"bearerFormat": "OPAQUE",
"scheme": "bearer",
"type": "http"
}
}
},
"info": {
"contact": {},
"description": "# Introduction\n\nThe Purchase-to-Pay APIs allow you to retrieve supplier invoices and purchase orders managed in Agicap, with all the information needed to automate their processing in your external tools.\nThese endpoints are designed to be called in combination with the pre-accounting export: once accounting entries are ready to export, you can enrich them with the full invoice payload and the associated purchase order details — to create supplier invoice objects in your ERP, close related purchase orders and deliveries, and trigger your existing accounting automations.\nThey can also be used independently, for any custom export workflow that requires access to raw invoice or purchase order data from Agicap.\n",
"title": "Purchase-to-Pay",
"version": "v1"
},
"openapi": "3.0.0",
"paths": {
"/public/invoices-management/v1/entities/{entityId}/inbox/documents": {
"get": {
"description": "Use this endpoint to list the invoices and credit notes currently in the entity's inbox (documents awaiting OCR verification), each with a temporary download link to its attached file.\nAny document that has an attached file is returned, whatever its type (PDF or image); a document with no attached file is excluded. Provide a last-synchronization date to pull only the documents collected since then.",
"operationId": "get_public-api/invoices-management/v1/entities/{entityid}/inbox/documents",
"parameters": [
{
"description": "The entity identifier.",
"in": "path",
"name": "entityId",
"required": true,
"schema": {
"format": "int32",
"type": "integer"
}
},
{
"description": "Only documents collected on or after this ISO-8601 datetime are returned. Omit to return the whole current inbox.",
"in": "query",
"name": "lastSynchronizationDate",
"schema": {
"format": "date-time",
"type": "string"
}
},
{
"description": "The maximum number of documents per page, between 1 and 100. Defaults to 100.",
"in": "query",
"name": "pageSize",
"schema": {
"default": 100,
"format": "int32",
"type": "integer"
}
},
{
"description": "The zero-based page index. Defaults to 0.",
"in": "query",
"name": "pageNumber",
"schema": {
"default": 0,
"format": "int32",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvoicesManagement.Web.Controllers.PublicApi.Responses.InboxDocumentsResponse"
}
}
},
"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 inbox documents",
"tags": [
"Inbox"
]
}
},
"/public/invoices-management/v1/entities/{entityId}/invoices": {
"post": {
"description": "Use this endpoint to retrieve full invoice details for a given list of invoice IDs. It returns all header-level information — supplier, amounts, status, due date, payment method — along with line items and their references to linked purchase order lines.\nThis is the primary endpoint to call when creating supplier invoices in an ERP: the line-level link to purchase order lines allows the ERP to automatically match the invoice against the right order and close it upon import.",
"operationId": "post_public-api/invoices-management/v1/entities/{entityid}/invoices",
"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.InvoiceQueryDto"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/InvoicesManagement.Web.Controllers.PublicApi.Dto.InvoiceQueryDto"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/InvoicesManagement.Web.Controllers.PublicApi.Dto.InvoiceQueryDto"
}
]
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvoicesManagement.Web.Controllers.PublicApi.Responses.InvoicesResponse"
}
}
},
"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 invoices",
"tags": [
"Invoices"
]
}
},
"/public/invoices-management/v1/entities/{entityId}/invoices/mark-as-verified": {
"post": {
"description": "Marks the specified invoices as verified for the given entity.",
"operationId": "post_public-api/invoices-management/v1/entities/{entityid}/invoices/mark-as-verified",
"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.MarkInvoicesAsVerifiedDto"
}
]
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/InvoicesManagement.Web.Controllers.PublicApi.Dto.MarkInvoicesAsVerifiedDto"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/InvoicesManagement.Web.Controllers.PublicApi.Dto.MarkInvoicesAsVerifiedDto"
}
]
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvoicesManagement.Web.Controllers.PublicApi.Responses.MarkInvoicesAsVerifiedResponse"
}
}
},
"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": "Mark invoices as verified",
"tags": [
"Invoices"
]
}
},
"/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.\nThis 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": {
"$r
# --- truncated at 32 KB (33 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/agicap/refs/heads/main/openapi/agicap-invoices-management-v1-openapi.json