Agicap Purchase journal API
The Purchase journal API from Agicap — 2 operation(s) for purchase journal.
OpenAPI Specification
openapi: 3.0.0
info:
contact: {}
title: Clients AR Account reports Purchase journal API
version: v1
servers:
- url: https://api.agicap.com
- url: https://api.agicap.internal
tags:
- name: Purchase journal
paths:
/public/purchase-journal/v1/entities/{entityId}/accounting-purchases:
get:
description: 'This endpoint retrieves purchase journal accounting entries from your Agicap account for a specific entity.
### Query Parameters
- **LastSynchronizationDate** (string, optional): The date of your last synchronization (need to be stored on your side). Only accounting entries exposed with the button “export to my accounting software” after this date will be returned.
- **PageSize** (int, optional): The number of entries returned per page. Default is 100. The maximum value is 100.
- **PageNumber** (int, optional): The page number of the results to retrieve. Used for pagination when fetching purchase journal entries. If not specified, defaults to page 1.
- **include** (string, optional): Opt-in enrichment selector. Pass `invoiceInformation` to enrich invoice entries with the `invoiceInformation` block. `invoiceInformation` is the only supported value; any other value is ignored. When omitted, the lighter default payload is returned and `invoiceInformation` is `null`.
### Document typology
Each entry carries a `typology` field that discriminates the source document. Possible values: `OwedInvoice`, `CreditNote`, `CardExpenseReceipt`, `CardRefundReceipt`, `ExpenseClaim`.
### invoiceInformation enrichment (opt-in)
When `?include=invoiceInformation` is passed, entries of typology `OwedInvoice` are enriched with an `invoiceInformation` object. It stays `null` for every other typology and whenever the parameter is omitted. The block contains:
- **supplier**, **reference**, **currency**, original amounts (excl./incl. taxes), **costCenter**, **natures**.
- **linkedPurchaseOrders[]**: the purchase orders linked to the invoice (empty when none), each with its own status, amounts, deliveries and the portion of the order amount linked to this invoice.
- **lineItems[]**: invoice line items, filtered to those matching `accountingLines[].lineItemId`. Each may carry a **linkedPurchaseOrderLine** (the matched purchase-order line, `null` when no match).
The `status` (on the invoice and on each linked purchase order) and `deliveryStatus` (on each linked purchase order) fields are free-form strings passed through from invoices-management.
#### Enrichment failure
If the enrichment cannot be resolved (the bulk invoice gateway or the purchase-order gateway fails), the endpoint returns `500` with error code `PublicApi_InvoiceEnrichmentFailed`. In that case the affected entries are **not** marked as exported and remain returned on a subsequent call, so a retry is safe.'
operationId: GetAccountingTransactionLines
parameters:
- in: path
name: entityId
required: true
schema:
format: int32
type: integer
- in: query
name: LastSynchronizationDate
schema:
format: date-time
type: string
- in: query
name: PageSize
schema:
format: int32
type: integer
- in: query
name: PageNumber
schema:
format: int32
type: integer
- description: Opt-in enrichment selector. Pass `invoiceInformation` to enrich entries of typology `OwedInvoice` with the `invoiceInformation` block (supplier, line items, linked purchase orders). `invoiceInformation` is the only supported value; any other value is ignored. Omit it to keep the lighter default payload.
in: query
name: Include
schema:
description: Opt-in enrichment selector. Pass `invoiceInformation` to enrich entries of typology `OwedInvoice` with the `invoiceInformation` block (supplier, line items, linked purchase orders). `invoiceInformation` is the only supported value; any other value is ignored. Omit it to keep the lighter default payload.
type: string
responses:
'200':
content:
application/json:
examples:
withInvoiceInformation:
value:
items:
- accountingLines:
- accountNumber: '401012'
accountType: SupplierAccount
accountingCurrency: EUR
additionalAnalyticalCodes: {}
analyticalCodes: {}
conversionRate: 0.8
convertedCreditAmount: 96
convertedDebitAmount: 0
credit: 120
currency: USD
debit: 0
lineItemId: null
taxKey: null
thirdPartyAccount: OVH
type: G
vatAccountName: null
- accountNumber: '6263'
accountType: ExpenseAccount
accountingCurrency: EUR
additionalAnalyticalCodes: {}
analyticalCodes:
BusinessScope: R&D
PurchaseType: Cloud servers
conversionRate: 0.8
convertedCreditAmount: 0
convertedDebitAmount: 80
credit: 0
currency: USD
debit: 100
lineItemId: a1b2c3d4-e5f6-7890-abcd-ef1234567890
taxKey: null
thirdPartyAccount: null
type: G
vatAccountName: VAT 20%
- accountNumber: '44566'
accountType: VatAccount
accountingCurrency: EUR
additionalAnalyticalCodes: {}
analyticalCodes: {}
conversionRate: 0.8
convertedCreditAmount: 0
convertedDebitAmount: 16
credit: 0
currency: USD
debit: 20
lineItemId: a1b2c3d4-e5f6-7890-abcd-ef1234567890
taxKey: '9'
thirdPartyAccount: null
type: G
vatAccountName: VAT 20%
agicapUniqueId: d3b07384-d9a3-4e5d-8c7c-8f9f1c2b3a4b
billingDate: '2024-12-16T00:00:00'
dueDate: '2024-12-16'
invoiceInformation:
costCenter: IT
currency: USD
lineItems:
- articleName: Cloud server XL
articleReference: SRV-XL
lineItemId: a1b2c3d4-e5f6-7890-abcd-ef1234567890
linkedPurchaseOrderLine:
articleName: Cloud server XL
articleReference: SRV-XL
billedQuantity: 1
deliveredQuantity: 1
linkedDeliveryNotesLines:
- deliveryNoteLineItemErpExternalId: ERP-DNL-001
deliveryNoteNumber: BL-001
- deliveryNoteLineItemErpExternalId: ERP-DNL-002
deliveryNoteNumber: BL-002
orderedQuantity: 1
purchaseOrderErpExternalId: ERP-PO-001
purchaseOrderId: b2c3d4e5-f6a7-8901-bcde-f12345678901
purchaseOrderLineItemErpExternalId: ERP-LINE-001
purchaseOrderLineItemId: c3d4e5f6-a7b8-9012-cdef-123456789012
totalAmountExcludingTaxes: 100
unitAmountExcludingTaxes: 100
quantity: 1
totalAmountExcludingTaxes: 100
unitAmountExcludingTaxes: 100
linkedPurchaseOrders:
- amountExcludingTaxes: 100
amountIncludingTaxes: 120
associatedAmountExcludingTaxes: 100
currency: USD
deliveries:
- date: '2024-12-20'
number: DN-001
deliveryDate: '2024-12-20'
deliveryStatus: Delivered
expectedPaymentDate: '2024-12-31'
number: PO-2024-001
purchaseOrderErpExternalId: ERP-PO-001
purchaseOrderId: b2c3d4e5-f6a7-8901-bcde-f12345678901
status: Received
supplier:
id: null
name: OVH
title: Cloud servers Q4
natures:
- Cloud
originalAmountExcludingTaxes: 100
originalAmountIncludingTaxes: 120
reference: INV-2024-12-OVH
status: Paid
supplier:
id: null
name: OVH
invoiceOrReceiptNumber: '20241216'
note: OVH invoice for december
orderNumbers:
- '20241216'
originalFileExtension: pdf
originalFileUrl: https://agicap.com/invoice1.pdf
paymentMethod: DebitCard
performanceDate: '2024-12-16T00:00:00'
prepaidExpenseEndDate: '2024-12-16'
prepaidExpenseStartDate: '2024-12-16'
supplierErpExternalId: ERP-OVH-001
supplierOrMerchant: OVH
taxKey: null
title: Invoice OVH December 2024
typology: OwedInvoice
uniqueId: 78dwxxd5
pagination:
currentPageItemsCount: 1
currentPageNumber: 1
pageSize: 1
pagesCount: 1
totalItemsCount: 1
withoutInvoiceInformation:
value:
items:
- accountingLines:
- accountNumber: '401012'
accountType: SupplierAccount
accountingCurrency: EUR
additionalAnalyticalCodes: {}
analyticalCodes: {}
conversionRate: 0.8
convertedCreditAmount: 96
convertedDebitAmount: 0
credit: 120
currency: USD
debit: 0
lineItemId: null
taxKey: null
thirdPartyAccount: OVH
type: G
vatAccountName: null
- accountNumber: '6263'
accountType: ExpenseAccount
accountingCurrency: EUR
additionalAnalyticalCodes: {}
analyticalCodes:
BusinessScope: R&D
PurchaseType: Cloud servers
conversionRate: 0.8
convertedCreditAmount: 0
convertedDebitAmount: 80
credit: 0
currency: USD
debit: 100
lineItemId: a1b2c3d4-e5f6-7890-abcd-ef1234567890
taxKey: null
thirdPartyAccount: null
type: G
vatAccountName: VAT 20%
- accountNumber: '44566'
accountType: VatAccount
accountingCurrency: EUR
additionalAnalyticalCodes: {}
analyticalCodes: {}
conversionRate: 0.8
convertedCreditAmount: 0
convertedDebitAmount: 16
credit: 0
currency: USD
debit: 20
lineItemId: a1b2c3d4-e5f6-7890-abcd-ef1234567890
taxKey: '9'
thirdPartyAccount: null
type: G
vatAccountName: VAT 20%
agicapUniqueId: d3b07384-d9a3-4e5d-8c7c-8f9f1c2b3a4b
billingDate: '2024-12-16T00:00:00'
dueDate: '2024-12-16'
invoiceInformation: null
invoiceOrReceiptNumber: '20241216'
note: OVH invoice for december
orderNumbers:
- '20241216'
originalFileExtension: pdf
originalFileUrl: https://agicap.com/invoice1.pdf
paymentMethod: DebitCard
performanceDate: '2024-12-16T00:00:00'
prepaidExpenseEndDate: '2024-12-16'
prepaidExpenseStartDate: '2024-12-16'
supplierErpExternalId: ERP-OVH-001
supplierOrMerchant: OVH
taxKey: null
title: Invoice OVH December 2024
typology: OwedInvoice
uniqueId: 78dwxxd5
pagination:
currentPageItemsCount: 1
currentPageNumber: 1
pageSize: 1
pagesCount: 1
totalItemsCount: 1
schema:
$ref: '#/components/schemas/PagedResult`1<PurchaseJournal.UseCases.Ports.PublicApiPurchaseJournalPresentation>'
text/json:
examples:
withInvoiceInformation:
value:
items:
- accountingLines:
- accountNumber: '401012'
accountType: SupplierAccount
accountingCurrency: EUR
additionalAnalyticalCodes: {}
analyticalCodes: {}
conversionRate: 0.8
convertedCreditAmount: 96
convertedDebitAmount: 0
credit: 120
currency: USD
debit: 0
lineItemId: null
taxKey: null
thirdPartyAccount: OVH
type: G
vatAccountName: null
- accountNumber: '6263'
accountType: ExpenseAccount
accountingCurrency: EUR
additionalAnalyticalCodes: {}
analyticalCodes:
BusinessScope: R&D
PurchaseType: Cloud servers
conversionRate: 0.8
convertedCreditAmount: 0
convertedDebitAmount: 80
credit: 0
currency: USD
debit: 100
lineItemId: a1b2c3d4-e5f6-7890-abcd-ef1234567890
taxKey: null
thirdPartyAccount: null
type: G
vatAccountName: VAT 20%
- accountNumber: '44566'
accountType: VatAccount
accountingCurrency: EUR
additionalAnalyticalCodes: {}
analyticalCodes: {}
conversionRate: 0.8
convertedCreditAmount: 0
convertedDebitAmount: 16
credit: 0
currency: USD
debit: 20
lineItemId: a1b2c3d4-e5f6-7890-abcd-ef1234567890
taxKey: '9'
thirdPartyAccount: null
type: G
vatAccountName: VAT 20%
agicapUniqueId: d3b07384-d9a3-4e5d-8c7c-8f9f1c2b3a4b
billingDate: '2024-12-16T00:00:00'
dueDate: '2024-12-16'
invoiceInformation:
costCenter: IT
currency: USD
lineItems:
- articleName: Cloud server XL
articleReference: SRV-XL
lineItemId: a1b2c3d4-e5f6-7890-abcd-ef1234567890
linkedPurchaseOrderLine:
articleName: Cloud server XL
articleReference: SRV-XL
billedQuantity: 1
deliveredQuantity: 1
linkedDeliveryNotesLines:
- deliveryNoteLineItemErpExternalId: ERP-DNL-001
deliveryNoteNumber: BL-001
- deliveryNoteLineItemErpExternalId: ERP-DNL-002
deliveryNoteNumber: BL-002
orderedQuantity: 1
purchaseOrderErpExternalId: ERP-PO-001
purchaseOrderId: b2c3d4e5-f6a7-8901-bcde-f12345678901
purchaseOrderLineItemErpExternalId: ERP-LINE-001
purchaseOrderLineItemId: c3d4e5f6-a7b8-9012-cdef-123456789012
totalAmountExcludingTaxes: 100
unitAmountExcludingTaxes: 100
quantity: 1
totalAmountExcludingTaxes: 100
unitAmountExcludingTaxes: 100
linkedPurchaseOrders:
- amountExcludingTaxes: 100
amountIncludingTaxes: 120
associatedAmountExcludingTaxes: 100
currency: USD
deliveries:
- date: '2024-12-20'
number: DN-001
deliveryDate: '2024-12-20'
deliveryStatus: Delivered
expectedPaymentDate: '2024-12-31'
number: PO-2024-001
purchaseOrderErpExternalId: ERP-PO-001
purchaseOrderId: b2c3d4e5-f6a7-8901-bcde-f12345678901
status: Received
supplier:
id: null
name: OVH
title: Cloud servers Q4
natures:
- Cloud
originalAmountExcludingTaxes: 100
originalAmountIncludingTaxes: 120
reference: INV-2024-12-OVH
status: Paid
supplier:
id: null
name: OVH
invoiceOrReceiptNumber: '20241216'
note: OVH invoice for december
orderNumbers:
- '20241216'
originalFileExtension: pdf
originalFileUrl: https://agicap.com/invoice1.pdf
paymentMethod: DebitCard
performanceDate: '2024-12-16T00:00:00'
prepaidExpenseEndDate: '2024-12-16'
prepaidExpenseStartDate: '2024-12-16'
supplierErpExternalId: ERP-OVH-001
supplierOrMerchant: OVH
taxKey: null
title: Invoice OVH December 2024
typology: OwedInvoice
uniqueId: 78dwxxd5
pagination:
currentPageItemsCount: 1
currentPageNumber: 1
pageSize: 1
pagesCount: 1
totalItemsCount: 1
withoutInvoiceInformation:
value:
items:
- accountingLines:
- accountNumber: '401012'
accountType: SupplierAccount
accountingCurrency: EUR
additionalAnalyticalCodes: {}
analyticalCodes: {}
conversionRate: 0.8
convertedCreditAmount: 96
convertedDebitAmount: 0
credit: 120
currency: USD
debit: 0
lineItemId: null
taxKey: null
thirdPartyAccount: OVH
type: G
vatAccountName: null
- accountNumber: '6263'
accountType: ExpenseAccount
accountingCurrency: EUR
additionalAnalyticalCodes: {}
analyticalCodes:
BusinessScope: R&D
PurchaseType: Cloud servers
conversionRate: 0.8
convertedCreditAmount: 0
convertedDebitAmount: 80
credit: 0
currency: USD
debit: 100
lineItemId: a1b2c3d4-e5f6-7890-abcd-ef1234567890
taxKey: null
thirdPartyAccount: null
type: G
vatAccountName: VAT 20%
- accountNumber: '44566'
accountType: VatAccount
accountingCurrency: EUR
additionalAnalyticalCodes: {}
analyticalCodes: {}
conversionRate: 0.8
convertedCreditAmount: 0
convertedDebitAmount: 16
credit: 0
currency: USD
debit: 20
lineItemId: a1b2c3d4-e5f6-7890-abcd-ef1234567890
taxKey: '9'
thirdPartyAccount: null
type: G
vatAccountName: VAT 20%
agicapUniqueId: d3b07384-d9a3-4e5d-8c7c-8f9f1c2b3a4b
billingDate: '2024-12-16T00:00:00'
dueDate: '2024-12-16'
invoiceInformation: null
invoiceOrReceiptNumber: '20241216'
note: OVH invoice for december
orderNumbers:
- '20241216'
originalFileExtension: pdf
originalFileUrl: https://agicap.com/invoice1.pdf
paymentMethod: DebitCard
performanceDate: '2024-12-16T00:00:00'
prepaidExpenseEndDate: '2024-12-16'
prepaidExpenseStartDate: '2024-12-16'
supplierErpExternalId: ERP-OVH-001
supplierOrMerchant: OVH
taxKey: null
title: Invoice OVH December 2024
typology: OwedInvoice
uniqueId: 78dwxxd5
pagination:
currentPageItemsCount: 1
currentPageNumber: 1
pageSize: 1
pagesCount: 1
totalItemsCount: 1
schema:
$ref: '#/components/schemas/PagedResult`1<PurchaseJournal.UseCases.Ports.PublicApiPurchaseJournalPresentation>'
text/plain:
examples:
withInvoiceInformation:
value:
items:
- accountingLines:
- accountNumber: '401012'
accountType: SupplierAccount
accountingCurrency: EUR
additionalAnalyticalCodes: {}
analyticalCodes: {}
conversionRate: 0.8
convertedCreditAmount: 96
convertedDebitAmount: 0
credit: 120
currency: USD
debit: 0
lineItemId: null
taxKey: null
thirdPartyAccount: OVH
type: G
vatAccountName: null
- accountNumber: '6263'
accountType: ExpenseAccount
accountingCurrency: EUR
additionalAnalyticalCodes: {}
analyticalCodes:
BusinessScope: R&D
PurchaseType: Cloud servers
conversionRate: 0.8
convertedCreditAmount: 0
convertedDebitAmount: 80
credit: 0
currency: USD
debit: 100
lineItemId: a1b2c3d4-e5f6-7890-abcd-ef1234567890
taxKey: null
thirdPartyAccount: null
type: G
vatAccountName: VAT 20%
- accountNumber: '44566'
accountType: VatAccount
accountingCurrency: EUR
additionalAnalyticalCodes: {}
analyticalCodes: {}
conversionRate: 0.8
convertedCreditAmount: 0
convertedDebitAmount: 16
credit: 0
currency: USD
debit: 20
lineItemId: a1b2c3d4-e5f6-7890-abcd-ef1234567890
taxKey: '9'
thirdPartyAccount: null
type: G
vatAccountName: VAT 20%
agicapUniqueId: d3b07384-d9a3-4e5d-8c7c-8f9f1c2b3a4b
billingDate: '2024-12-16T00:00:00'
dueDate: '2024-12-16'
invoiceInformation:
costCenter: IT
currency: USD
lineItems:
- articleName: Cloud server XL
articleReference: SRV-XL
lineItemId: a1b2c3d4-e5f6-7890-abcd-ef1234567890
linkedPurchaseOrderLine:
articleName: Cloud server XL
articleReference: SRV-XL
billedQuantity: 1
deliveredQuantity: 1
linkedDeliveryNotesLines:
- deliveryNoteLineItemErpExternalId: ERP-DNL-001
deliveryNoteNumber: BL-001
- deliveryNoteLineItemErpExternalId: ERP-DNL-002
deliveryNoteNumber: BL-002
orderedQuantity: 1
purchaseOrderErpExternalId: ERP-PO-001
purchaseOrderId: b2c3d4e5-f6a7-8901-bcde-f12345678901
purchaseOrderLineItemErpExternalId: ERP-LINE-001
purchaseOrderLineItemId: c3d4e5f6-a7b8-9012-cdef-123456789012
totalAmountExcludingTaxes: 100
unitAmountExcludingTaxes: 100
quantity: 1
totalAmountExcludingTaxes: 100
unitAmountExcludingTaxes: 100
linkedPurchaseOrders:
- amountExcludingTaxes: 100
amountIncludingTaxes: 120
associatedAmountExcludingTaxes: 100
currency: USD
deliveries:
- date: '2024-12-20'
number: DN-001
deliveryDate: '2024-12-20'
deliveryStatus: Delivered
expectedPaymentDate: '2024-12-31'
number: PO-2024-001
purchaseOrderErpExternalId: ERP-PO-001
purchaseOrderId: b2c3d4e5-f6a7-8901-bcde-f12345678901
status: Received
supplier:
id: null
name: OVH
title: Cloud servers Q4
natures:
- Cloud
originalAmountExcludingTaxes: 100
originalAmountIncludingTaxes: 120
reference: INV-2024-12-OVH
status: Paid
supplier:
id: null
name: OVH
invoiceOrReceiptNumber: '20241216'
note: OVH invoice for december
orderNumbers:
- '20241216'
originalFileExtension: pdf
originalFileUrl: https://agicap.com/invoice1.pdf
paymentMethod: DebitCard
performanceDate: '2024-12-16T00:00:00'
prepaidExpenseEndDate: '2024-12-16'
prepaidExpenseStartDate: '2024-12-16'
supplierErpExternalId: ERP-OVH-001
supplierOrMerchant: OVH
taxKey: null
title: Invoice OVH December 2024
typology: OwedInvoice
uniqueId: 78dwxxd5
pagination:
currentPageItemsCount: 1
currentPageNumber: 1
pageSize: 1
pagesCount: 1
totalItemsCount: 1
withoutInvoiceInformation:
value:
items:
- accountingLines:
- accountNumber: '401012'
accountType: SupplierAccount
accountingCurrency: EUR
additionalAnalyticalCodes: {}
analyticalCodes: {}
conversionRate: 0.8
convertedCreditAmount: 96
convertedDebitAmount: 0
credit: 120
currency: USD
debit: 0
lineItemId: null
taxKey: null
thirdPartyAccount: OVH
type: G
vatAccountName: null
- accountNumber: '6263'
accountType: ExpenseAccount
accountingCurrency: EUR
additionalAnalyticalCodes: {}
analyticalCodes:
BusinessScope: R&D
PurchaseType: Cloud servers
conversionRate: 0.8
convertedCreditAmount: 0
convertedDebitAmount: 80
credit: 0
currency: USD
# --- truncated at 32 KB (57 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/agicap/refs/heads/main/openapi/agicap-purchase-journal-api-openapi.yml