Agicap Beta API
The Beta API from Agicap — 16 operation(s) for beta.
OpenAPI Specification
openapi: 3.0.0
info:
contact: {}
title: Clients AR Account reports Beta API
version: v1
servers:
- url: https://api.agicap.com
- url: https://api.agicap.internal
tags:
- name: Beta
paths:
/public/business-documents/v1/entities/{entityid}/connections/{connectionid}/client-credit-notes/{id}/attach-readable:
post:
operationId: Beta_ClientCreditNoteAttachReadable
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: Unique identifier generated by Agicap
in: path
name: id
required: true
schema:
description: Unique identifier generated by Agicap
format: uuid
type: string
requestBody:
content:
multipart/form-data:
encoding:
file:
style: form
schema:
properties:
file:
description: Readable file of the document in PDF format
format: binary
type: string
required:
- file
type: object
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
nullable: true
type: string
instance:
nullable: true
type: string
status:
description: Code status
nullable: true
type: integer
title:
description: Name of the error
nullable: true
type: string
type:
description: Type of error
nullable: true
type: string
type: object
description: An internal server occurred.
security:
- bearer_client_credentials:
- agicap:public-api
- bearer_client_credentials:
- agicap:public-api
- bearerAuth: []
summary: Attach readable on client credit note
tags:
- Beta
/public/business-documents/v1/entities/{entityid}/connections/{connectionid}/client-credit-notes/{id}/unattach-readable:
delete:
operationId: Beta_ClientCreditNoteUnattachReadable
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: Unique identifier generated by Agicap
in: path
name: id
required: true
schema:
description: Unique identifier generated by Agicap
format: uuid
type: string
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
nullable: true
type: string
instance:
nullable: true
type: string
status:
description: Code status
nullable: true
type: integer
title:
description: Name of the error
nullable: true
type: string
type:
description: Type of error
nullable: true
type: string
type: object
description: An internal server occurred.
security:
- bearer_client_credentials:
- agicap:public-api
- bearer_client_credentials:
- agicap:public-api
- bearerAuth: []
summary: Unattach readable on client credit note
tags:
- Beta
/public/business-documents/v1/entities/{entityid}/connections/{connectionid}/client-invoices/{id}/attach-readable:
post:
operationId: Beta_ClientInvoiceAttachReadable
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: Unique identifier generated by Agicap
in: path
name: id
required: true
schema:
description: Unique identifier generated by Agicap
format: uuid
type: string
requestBody:
content:
multipart/form-data:
encoding:
file:
style: form
schema:
properties:
file:
description: Readable file of the document in PDF format
format: binary
type: string
required:
- file
type: object
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
nullable: true
type: string
instance:
nullable: true
type: string
status:
description: Code status
nullable: true
type: integer
title:
description: Name of the error
nullable: true
type: string
type:
description: Type of error
nullable: true
type: string
type: object
description: An internal server occurred.
security:
- bearer_client_credentials:
- agicap:public-api
- bearer_client_credentials:
- agicap:public-api
- bearerAuth: []
summary: Attach readable on client invoice
tags:
- Beta
/public/business-documents/v1/entities/{entityid}/connections/{connectionid}/client-invoices/{id}/unattach-readable:
delete:
operationId: Beta_ClientInvoiceUnattachReadable
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: Unique identifier generated by Agicap
in: path
name: id
required: true
schema:
description: Unique identifier generated by Agicap
format: uuid
type: string
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
nullable: true
type: string
instance:
nullable: true
type: string
status:
description: Code status
nullable: true
type: integer
title:
description: Name of the error
nullable: true
type: string
type:
description: Type of error
nullable: true
type: string
type: object
description: An internal server occurred.
security:
- bearer_client_credentials:
- agicap:public-api
- bearer_client_credentials:
- agicap:public-api
- bearerAuth: []
summary: Unattach readable on client invoice
tags:
- Beta
/public/business-documents/v1/entities/{entityid}/connections/{connectionid}/supplier-credit-notes/{id}/attach-readable:
post:
operationId: Beta_SupplierCreditNoteAttachReadable
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: Unique identifier generated by Agicap
in: path
name: id
required: true
schema:
description: Unique identifier generated by Agicap
format: uuid
type: string
requestBody:
content:
multipart/form-data:
encoding:
file:
style: form
schema:
properties:
file:
description: Readable file of the document in PDF format
format: binary
type: string
required:
- file
type: object
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
nullable: true
type: string
instance:
nullable: true
type: string
status:
description: Code status
nullable: true
type: integer
title:
description: Name of the error
nullable: true
type: string
type:
description: Type of error
nullable: true
type: string
type: object
description: An internal server occurred.
security:
- bearer_client_credentials:
- agicap:public-api
- bearer_client_credentials:
- agicap:public-api
- bearerAuth: []
summary: Attach readable on supplier credit note
tags:
- Beta
/public/business-documents/v1/entities/{entityid}/connections/{connectionid}/supplier-credit-notes/{id}/unattach-readable:
delete:
operationId: Beta_SupplierCreditNoteUnattachReadable
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: Unique identifier generated by Agicap
in: path
name: id
required: true
schema:
description: Unique identifier generated by Agicap
format: uuid
type: string
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
nullable: true
type: string
instance:
nullable: true
type: string
status:
description: Code status
nullable: true
type: integer
title:
description: Name of the error
nullable: true
type: string
type:
description: Type of error
nullable: true
type: string
type: object
description: An internal server occurred.
security:
- bearer_client_credentials:
- agicap:public-api
- bearer_client_credentials:
- agicap:public-api
- bearerAuth: []
summary: Unattach readable on supplier credit note
tags:
- Beta
/public/business-documents/v1/entities/{entityid}/connections/{connectionid}/supplier-invoices/{id}/attach-readable:
post:
operationId: Beta_SupplierInvoiceAttachReadable
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: Unique identifier generated by Agicap
in: path
name: id
required: true
schema:
description: Unique identifier generated by Agicap
format: uuid
type: string
requestBody:
content:
multipart/form-data:
encoding:
file:
style: form
schema:
properties:
file:
description: Readable file of the document in PDF format
format: binary
type: string
required:
- file
type: object
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
nullable: true
type: string
instance:
nullable: true
type: string
status:
description: Code status
nullable: true
type: integer
title:
description: Name of the error
nullable: true
type: string
type:
description: Type of error
nullable: true
type: string
type: object
description: An internal server occurred.
security:
- bearer_client_credentials:
- agicap:public-api
- bearer_client_credentials:
- agicap:public-api
- bearerAuth: []
summary: Attach readable on supplier invoice
tags:
- Beta
/public/business-documents/v1/entities/{entityid}/connections/{connectionid}/supplier-invoices/{id}/unattach-readable:
delete:
operationId: Beta_SupplierInvoiceUnattachReadable
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: Unique identifier generated by Agicap
in: path
name: id
required: true
schema:
description: Unique identifier generated by Agicap
format: uuid
type: string
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
nullable: true
type: string
instance:
nullable: true
type: string
status:
description: Code status
nullable: true
type: integer
title:
description: Name of the error
nullable: true
type: string
type:
description: Type of error
nullable: true
type: string
type: object
description: An internal server occurred.
security:
- bearer_client_credentials:
- agicap:public-api
- bearer_client_credentials:
- agicap:public-api
- bearerAuth: []
summary: Unattach readable on supplier invoice
tags:
- Beta
/public/business-documents/v2/entities/{entityid}/connections/{connectionid}/client-credit-notes/{id}/attach-readable:
post:
operationId: Beta_ClientCreditNoteAttachReadable
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: Unique identifier generated by Agicap
in: path
name: id
required: true
schema:
description: Unique identifier generated by Agicap
format: uuid
type: string
requestBody:
content:
multipart/form-data:
encoding:
file:
style: form
schema:
properties:
file:
description: Readable file of the document in PDF format
format: binary
type: string
required:
- file
type: object
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
nullable: true
type: string
instance:
nullable: true
type: string
status:
description: Code status
nullable: true
type: integer
title:
description: Name of the error
nullable: true
type: string
type:
description: Type of error
nullable: true
type: string
type: object
description: An internal server occurred.
security:
- bearer_client_credentials:
- agicap:public-api
- bearer_client_credentials:
- agicap:public-api
- bearerAuth: []
summary: Attach readable on client credit note
tags:
- Beta
/public/business-documents/v2/entities/{entityid}/connections/{connectionid}/client-credit-notes/{id}/unattach-readable:
delete:
operationId: Beta_ClientCreditNoteUnattachReadable
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: Unique identifier generated by Agicap
in: path
name: id
required: true
schema:
description: Unique identifier generated by Agicap
format: uuid
type: string
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
nullable: true
type: string
instance:
nullable: true
type: string
status:
description: Code status
nullable: true
type: integer
title:
description: Name of the error
nullable: true
type: string
type:
description: Type of error
nullable: true
type: string
type: object
description: An internal server occurred.
security:
- bearer_client_credentials:
- agicap:public-api
- bearer_client_credentials:
- agicap:public-api
- bearerAuth: []
summary: Unattach readable on client credit note
tags:
- Beta
/public/business-documents/v2/entities/{entityid}/connections/{connectionid}/client-invoices/{id}/attach-readable:
post:
operationId: Beta_ClientInvoiceAttachReadable
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: Unique identifier generated by Agicap
in: path
name: id
required: true
schema:
description: Unique identifier generated by Agicap
format: uuid
type: string
requestBody:
content:
multipart/form-data:
encoding:
file:
style: form
schema:
properties:
file:
description: Readable file of the document in PDF format
format: binary
type: string
required:
- file
type: object
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
nullable: true
type: string
instance:
nullable: true
type: string
status:
description: Code status
nullable: true
type: integer
title:
description: Name of the error
nullable: true
type: string
type:
description: Type of error
nullable: true
type: string
type: object
description: An internal server occurred.
security:
- bearer_client_credentials:
- agicap:public-api
- bearer_client_credentials:
- agicap:public-api
- bearerAuth: []
summary: Attach readable on client invoice
tags:
- Beta
/public/business-documents/v2/entities/{entityid}/connections/{connectionid}/client-invoices/{id}/unattach-readable:
delete:
operationId: Beta_ClientInvoiceUnattachReadable
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: Unique identifier generated by Agicap
in: path
name: id
required: true
schema:
description: Unique identifier generated by Agicap
format: uuid
type: string
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
nullable: true
type: string
instance:
nullable: true
type: string
status:
description: Code status
nullable: true
type: integer
title:
description: Name of the error
nullable: true
type: string
type:
description: Type of error
nullable: true
type: string
type: object
description: An internal server occurred.
security:
- bearer_client_credentials:
- agicap:public-api
- bearer_client_credentials:
- agicap:public-api
- bearerAuth: []
summary: Unattach readable on client invoice
tags:
- Beta
/public/business-documents/v2/entities/{entityid}/connections/{connectionid}/supplier-credit-notes/{id}/attach-readable:
post:
operationId: Beta_SupplierCreditNoteAttachReadable
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: Unique identifier generated by Agicap
in: path
name: id
required: true
schema:
description: Unique identifier generated by Agicap
format: uuid
type: string
requestBody:
content:
multipart/form-data:
encoding:
file:
style: form
schema:
properties:
file:
description: Readable file of the document in PDF format
format: binary
type: string
required:
- file
type: object
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
nullable: true
type: string
instance:
nullable: true
type: string
status:
description: Code status
nullable: true
type: integer
title:
description: Name of the error
nullable: true
type: string
type:
description: Type of error
nullable: true
type: string
type: object
description: An internal server occurred.
security:
- bearer_client_credentials:
- agicap:public-api
- bearer_client_credentials:
- agicap:public-api
- bearerAuth: []
summary: Attach readable on supplier credit note
tags:
- Beta
/public/business-documents/v2/entities/{entityid}/connections/{connectionid}/supplier-credit-notes/{id}/unattach-readable:
delete:
operationId: Beta_SupplierCreditNoteUnattachReadable
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: Unique identifier generated by Agicap
in: path
name: id
required: true
sch
# --- truncated at 32 KB (38 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/agicap/refs/heads/main/openapi/agicap-beta-api-openapi.yml