Agicap Business Documents (v2)
Create, retrieve, or update invoices, credit notes, sales orders, and other business documents used by Agicap
OpenAPI Specification
{
"components": {
"schemas": {
"AccountingDto": {
"additionalProperties": false,
"properties": {
"accountCode": {
"description": "Represents the account Code of the Third Party Account the invoice is linked to.",
"nullable": true,
"type": "string"
},
"accountNumber": {
"description": "Represents the account number of the invoice. It is used to classify financial activities and balances within the General Ledger.",
"nullable": true,
"type": "string"
},
"amount": {
"description": "Represents the total amount of the invoice in the accounting currency.",
"format": "double",
"nullable": true,
"type": "number"
},
"currency": {
"description": "Represents the currency used in the accounting process (which can be different from the invoice currency).",
"nullable": true,
"type": "string"
}
},
"title": "InvoiceAccounting",
"type": "object"
},
"AccountingDtoV2": {
"additionalProperties": false,
"properties": {
"accountCode": {
"description": "Represents the account Code of the Third Party Account the invoice is linked to.",
"nullable": true,
"type": "string"
},
"accountNumber": {
"description": "Represents the account number of the invoice. It is used to classify financial activities and balances within the General Ledger.",
"nullable": true,
"type": "string"
},
"amount": {
"description": "Represents the total amount of the invoice in the accounting currency. (amount must be positive)",
"format": "double",
"nullable": true,
"type": "number"
},
"currency": {
"description": "Represents the currency code in ISO 4217 format used in the accounting process (which can be different from the invoice currency).",
"nullable": true,
"type": "string"
}
},
"title": "InvoiceAccounting",
"type": "object"
},
"AmountsWithDueAmountDto": {
"additionalProperties": false,
"properties": {
"dueAmount": {
"description": "Due amount in the document currency.",
"format": "double",
"nullable": true,
"type": "number"
},
"taxesAmount": {
"description": "Taxes amount in the document currency",
"format": "double",
"nullable": true,
"type": "number"
},
"totalAmount": {
"description": "Total amount in the document currency.",
"format": "double",
"type": "number"
}
},
"required": [
"totalAmount"
],
"title": "AmountsWithDueAmount",
"type": "object"
},
"AmountsWithDueAmountDtoV2": {
"additionalProperties": false,
"properties": {
"dueAmount": {
"description": "Due amount in the document currency. (amount must be positive)",
"format": "double",
"type": "number"
},
"taxesAmount": {
"description": "Taxes amount in the document currency. (amount must be positive)",
"format": "double",
"type": "number"
},
"totalAmount": {
"description": "Total amount in the document currency. (amount must be positive)",
"format": "double",
"type": "number"
}
},
"required": [
"dueAmount",
"taxesAmount",
"totalAmount"
],
"title": "AmountsWithDueAmount",
"type": "object"
},
"AmountsWithRemainingAmountDto": {
"additionalProperties": false,
"properties": {
"remainingAmount": {
"description": "Remaining amount in the document currency.",
"format": "double",
"nullable": true,
"type": "number"
},
"taxesAmount": {
"description": "Taxes amount in the document currency",
"format": "double",
"nullable": true,
"type": "number"
},
"totalAmount": {
"description": "Total amount in the document currency.",
"format": "double",
"type": "number"
}
},
"required": [
"totalAmount"
],
"title": "AmountsWithRemainingAmount",
"type": "object"
},
"AmountsWithRemainingAmountDtoV2": {
"additionalProperties": false,
"properties": {
"remainingAmount": {
"description": "Remaining amount in the document currency. (amount must be positive)",
"format": "double",
"type": "number"
},
"taxesAmount": {
"description": "Taxes amount in the document currency (amount must be positive)",
"format": "double",
"type": "number"
},
"totalAmount": {
"description": "Total amount in the document currency. (amount must be positive)",
"format": "double",
"type": "number"
}
},
"required": [
"remainingAmount",
"taxesAmount",
"totalAmount"
],
"title": "AmountsWithRemainingAmount",
"type": "object"
},
"ClientCreditNoteDto": {
"additionalProperties": false,
"properties": {
"accounting": {
"$ref": "#/components/schemas/AccountingDto"
},
"amounts": {
"$ref": "#/components/schemas/AmountsWithRemainingAmountDto"
},
"counterParty": {
"$ref": "#/components/schemas/CounterPartyDto"
},
"creditNoteNumber": {
"description": "Document number in the source data",
"nullable": true,
"type": "string"
},
"currency": {
"description": "Currency code in ISO 4217 format",
"minLength": 1,
"type": "string"
},
"dueDate": {
"description": "Due date in ISO 8601 format",
"format": "date-time",
"nullable": true,
"type": "string"
},
"erpIdentificationFields": {
"additionalProperties": {
"type": "string"
},
"nullable": true,
"type": "object"
},
"externalId": {
"description": "Unique identifier of the document in the source data",
"minLength": 1,
"type": "string"
},
"hasReadable": {
"description": "Has a readable file attached",
"type": "boolean"
},
"id": {
"description": "Unique identifier generated by Agicap",
"format": "uuid",
"type": "string"
},
"issueDate": {
"description": "Issue date in ISO 8601 format",
"format": "date-time",
"nullable": true,
"type": "string"
},
"label": {
"description": "Label of the client credit note that will be displayed in treasury",
"nullable": true,
"type": "string"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Additional metadata as a JSON Object",
"nullable": true,
"type": "object"
},
"referenceInvoiceIds": {
"description": "Array of linked Agicap Invoices ids",
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
},
"status": {
"description": "Possible values : draft, available, used, cancelled, deleted",
"minLength": 1,
"type": "string"
}
},
"required": [
"amounts",
"currency",
"externalId",
"id",
"status"
],
"title": "ClientCreditNote",
"type": "object"
},
"ClientCreditNoteDtoPageDto": {
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/ClientCreditNoteDto"
},
"type": "array"
},
"pagination": {
"$ref": "#/components/schemas/PaginationMetadataDto"
}
},
"title": "Page",
"type": "object"
},
"ClientInvoiceDtoV2": {
"additionalProperties": false,
"properties": {
"accounting": {
"$ref": "#/components/schemas/AccountingDto"
},
"amounts": {
"$ref": "#/components/schemas/AmountsWithDueAmountDto"
},
"counterParty": {
"$ref": "#/components/schemas/CounterPartyDto"
},
"currency": {
"description": "Currency code in ISO 4217 format",
"minLength": 1,
"type": "string"
},
"dueDate": {
"description": "Due date in ISO 8601 format",
"format": "date-time",
"nullable": true,
"type": "string"
},
"erpIdentificationFields": {
"additionalProperties": {
"type": "string"
},
"nullable": true,
"type": "object"
},
"expectedPaymentDate": {
"description": "Expected Payment date in ISO 8601 format",
"format": "date-time",
"nullable": true,
"type": "string"
},
"externalId": {
"description": "Unique identifier of the document in the source data",
"minLength": 1,
"type": "string"
},
"financingSolution": {
"description": "Financing solution information",
"nullable": true,
"type": "string"
},
"hasReadable": {
"description": "Has a readable file attached",
"type": "boolean"
},
"id": {
"description": "Unique identifier generated by Agicap",
"format": "uuid",
"type": "string"
},
"instalments": {
"items": {
"$ref": "#/components/schemas/ClientInvoiceInstalmentDtoV2"
},
"nullable": true,
"type": "array"
},
"invoiceNumber": {
"description": "Document number in the source data",
"nullable": true,
"type": "string"
},
"issueDate": {
"description": "Issue date in ISO 8601 format",
"format": "date-time",
"nullable": true,
"type": "string"
},
"label": {
"description": "Label of the document",
"nullable": true,
"type": "string"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Additional metadata as a JSON Object",
"nullable": true,
"type": "object"
},
"paymentDate": {
"description": "Payment in full date in ISO 8601 format",
"format": "date-time",
"nullable": true,
"type": "string"
},
"status": {
"description": "Possible values : draft, due, paid, cancelled, deleted",
"minLength": 1,
"type": "string"
}
},
"required": [
"amounts",
"currency",
"externalId",
"id",
"status"
],
"title": "ClientInvoice",
"type": "object"
},
"ClientInvoiceDtoV2PageDto": {
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/ClientInvoiceDtoV2"
},
"type": "array"
},
"pagination": {
"$ref": "#/components/schemas/PaginationMetadataDto"
}
},
"title": "Page",
"type": "object"
},
"ClientInvoiceInstalmentDtoV2": {
"additionalProperties": false,
"properties": {
"accountingAmount": {
"$ref": "#/components/schemas/InstalmentAccountingAmountDto"
},
"amounts": {
"$ref": "#/components/schemas/InstalmentAmountsDtoV2"
},
"dueDate": {
"description": "Instalment due date in ISO 8601 format",
"format": "date-time",
"nullable": true,
"type": "string"
},
"erpIdentificationFields": {
"additionalProperties": {
"type": "string"
},
"nullable": true,
"type": "object"
},
"externalId": {
"description": "Unique identifier of the instalment in the source data",
"minLength": 1,
"type": "string"
},
"financingSolution": {
"description": "Financing solution name",
"nullable": true,
"type": "string"
},
"label": {
"description": "Instalment label",
"nullable": true,
"type": "string"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"nullable": true,
"type": "object"
},
"paymentDate": {
"description": "Payment date of the instalment",
"format": "date-time",
"nullable": true,
"type": "string"
},
"paymentMethod": {
"description": "Payment method used for the instalment",
"nullable": true,
"type": "string"
},
"status": {
"description": "Possible values : draft, due, partiallyPaid, paid, cancelled, paymentInProgress",
"minLength": 1,
"type": "string"
}
},
"required": [
"amounts",
"externalId",
"status"
],
"title": "ClientInvoiceInstalment",
"type": "object"
},
"ClientQuoteDto": {
"additionalProperties": false,
"properties": {
"amounts": {
"$ref": "#/components/schemas/AmountsWithRemainingAmountDto"
},
"counterParty": {
"$ref": "#/components/schemas/CounterPartyDto"
},
"currency": {
"description": "Currency code in ISO 4217 format",
"minLength": 1,
"type": "string"
},
"dueDate": {
"description": "Due date in ISO 8601 format",
"format": "date-time",
"nullable": true,
"type": "string"
},
"erpIdentificationFields": {
"additionalProperties": {
"type": "string"
},
"nullable": true,
"type": "object"
},
"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",
"nullable": true,
"type": "string"
},
"label": {
"description": "Label of the quote",
"nullable": true,
"type": "string"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Additional metadata as a JSON Object",
"nullable": true,
"type": "object"
},
"quoteNumber": {
"description": "Document number in the source data",
"nullable": true,
"type": "string"
},
"status": {
"description": "Possible values : draft, sent, accepted, refused, expired, partiallyinvoiced, invoiced, cancelled, deleted",
"minLength": 1,
"type": "string"
}
},
"required": [
"amounts",
"currency",
"externalId",
"id",
"status"
],
"title": "ClientQuote",
"type": "object"
},
"ClientQuoteDtoPageDto": {
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/ClientQuoteDto"
},
"type": "array"
},
"pagination": {
"$ref": "#/components/schemas/PaginationMetadataDto"
}
},
"title": "Page",
"type": "object"
},
"ConnectionDto": {
"additionalProperties": false,
"properties": {
"entityId": {
"description": "Agicap entity unique identifier",
"type": "string"
},
"id": {
"description": "Connection unique identifier",
"format": "uuid",
"type": "string"
},
"integrationName": {
"description": "Name of the data source. Example : Sage100, SAP B1",
"nullable": true,
"type": "string"
},
"name": {
"description": "Name of the connection",
"type": "string"
},
"source": {
"description": "Enables the identification of the team responsible for developing the connector. This field helps track which party developed the integration, providing transparency for troubleshooting, support, and future updates.\n- If you are an external integrator, put the \"External integrator - `{name_of_your_company}`\"\n- If you are the user’s in-house development team, put “Internal team”",
"nullable": true,
"type": "string"
}
},
"title": "Connection",
"type": "object"
},
"CounterPartyDto": {
"additionalProperties": false,
"properties": {
"id": {
"description": "Unique identifier of the linked Counterpart (Supplier / Client) in the source data",
"nullable": true,
"type": "string"
},
"name": {
"description": "Name of the linked Counterpart (Supplier / Client)",
"nullable": true,
"type": "string"
}
},
"title": "CounterParty",
"type": "object"
},
"CounterPartyDtoV2": {
"additionalProperties": false,
"properties": {
"id": {
"description": "Unique identifier of the linked Counterpart (Supplier / Client) in the source data",
"minLength": 1,
"type": "string"
},
"name": {
"description": "Name of the linked Counterpart (Supplier / Client)",
"minLength": 1,
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "CounterParty",
"type": "object"
},
"CreateClientCreditNoteDtoV2": {
"additionalProperties": false,
"properties": {
"accounting": {
"$ref": "#/components/schemas/AccountingDto"
},
"amounts": {
"$ref": "#/components/schemas/AmountsWithRemainingAmountDtoV2"
},
"counterParty": {
"$ref": "#/components/schemas/CounterPartyDtoV2"
},
"creditNoteNumber": {
"description": "Document number in the source data",
"minLength": 1,
"type": "string"
},
"currency": {
"description": "Currency code in ISO 4217 format",
"minLength": 1,
"type": "string"
},
"dueDate": {
"description": "Due date in ISO 8601 format",
"format": "date-time",
"nullable": true,
"type": "string"
},
"erpIdentificationFields": {
"additionalProperties": {
"type": "string"
},
"nullable": true,
"type": "object"
},
"externalId": {
"description": "Unique identifier of the document in the source data",
"minLength": 1,
"type": "string"
},
"issueDate": {
"description": "Issue date in ISO 8601 format",
"format": "date-time",
"type": "string"
},
"label": {
"description": "Label of the client credit note",
"nullable": true,
"type": "string"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Additional metadata as a JSON Object",
"nullable": true,
"type": "object"
},
"referenceInvoiceIds": {
"description": "Array of linked Agicap Invoices ids",
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
},
"status": {
"description": "Possible values : draft, available, used, cancelled, deleted",
"minLength": 1,
"type": "string"
}
},
"required": [
"amounts",
"counterParty",
"creditNoteNumber",
"currency",
"externalId",
"issueDate",
"status"
],
"title": "CreateClientCreditNote",
"type": "object"
},
"CreateClientInvoiceDtoV2": {
"additionalProperties": false,
"properties": {
"accounting": {
"$ref": "#/components/schemas/AccountingDtoV2"
},
"amounts": {
"$ref": "#/components/schemas/AmountsWithDueAmountDtoV2"
},
"counterParty": {
"$ref": "#/components/schemas/CounterPartyDtoV2"
},
"currency": {
"description": "Currency code in ISO 4217 format",
"minLength": 1,
"type": "string"
},
"dueDate": {
"description": "Due date in ISO 8601 format",
"format": "date-time",
"type": "string"
},
"erpIdentificationFields": {
"additionalProperties": {
"type": "string"
},
"nullable": true,
"type": "object"
},
"expectedPaymentDate": {
"description": "Expected Payment date in ISO 8601 format",
"format": "date-time",
"nullable": true,
"type": "string"
},
"externalId": {
"description": "Unique identifier of the document in the source data",
"minLength": 1,
"type": "string"
},
"financingSolution": {
"description": "Financing solution information",
"nullable": true,
"type": "string"
},
"instalments": {
"items": {
"$ref": "#/components/schemas/ClientInvoiceInstalmentDtoV2"
},
"nullable": true,
"type": "array"
},
"invoiceNumber": {
"description": "Document number in the source data",
"minLength": 1,
"type": "string"
},
"issueDate": {
"description": "Issue date in ISO 8601 format",
"format": "date-time",
"type": "string"
},
"label": {
"description": "Label of the document",
"nullable": true,
"type": "string"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Additional metadata as a JSON Object",
"nullable": true,
"type": "object"
},
"paymentDate": {
"description": "Payment in full date in ISO 8601 format",
"format": "date-time",
"nullable": true,
"type": "string"
},
"status": {
"description": "Possible values : draft, due, paid, cancelled, deleted",
"minLength": 1,
"type": "string"
}
},
"required": [
"amounts",
"counterParty",
"currency",
"dueDate",
"externalId",
"invoiceNumber",
"issueDate",
"status"
],
"title": "CreateClientInvoice",
"type": "object"
},
"CreateClientQuoteDtoV2": {
"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"
},
"dueDate": {
"description": "Due date in ISO 8601 format",
"format": "date-time",
"type": "string"
},
"erpIdentificationFields": {
"additionalProperties": {
"type": "string"
},
"nullable": true,
"type": "object"
},
"externalId": {
"description": "Unique identifier of the document in the source data",
"minLength": 1,
"type": "string"
},
"issueDate": {
"description": "Issue date in ISO 8601 format",
"format": "date-time",
"type": "string"
},
"label": {
"description": "Label of the document",
"nullable": true,
"type": "string"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Additional metadata as a JSON Object",
"nullable": true,
"type": "object"
},
"quoteNumber": {
"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",
"issueDate",
"quoteNumber",
"status"
],
"title": "CreateClientQuote",
"type": "object"
},
"CreateConnectionDto": {
"additionalProperties": false,
"properties": {
"integrationName": {
"description": "Name of the data source",
"nullable": true,
"type": "string"
},
"name": {
"description": "Name of the connection",
"nullable": true,
"type": "string"
},
"source": {
"description": "Enables the identification of the team responsible for developing the connector. This field helps track which party developed the integration, providing transparency for troubleshooting, support, and future updates.\n- If you are an external integrator, put the \"External integrator - `{name_of_your_company}`\"\n- If you are the user’s in-house development team, put “Internal team”",
"nullable": true,
"type": "string"
}
},
"title": "CreateConnection",
"type": "object"
},
"CreateDeliveryNoteDto": {
"additionalProperties": false,
"properties": {
"deliveryDate": {
"description": "Delivery date in ISO 8601 format",
"format": "date-time",
"type": "string"
},
"deliveryNoteNumber": {
"description": "Delivery note number in the source data",
"minLength": 1,
"type": "string"
},
"externalId": {
"description": "Unique identifier of the document in the source data",
"minLength": 1,
"type": "string"
},
"lineItems": {
"description": "Line items of the delivery note.",
"items": {
"$ref": "#/components/schemas/DeliveryNoteLineItemDto"
},
"nullable": true,
"type": "array"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Additional metadata as a JSON Object",
"nullable": true,
"type": "object"
}
},
"required": [
"deliveryDate",
"deliveryNoteNumber",
"externalId"
],
"type": "object"
},
"CreateProformaInvoiceDtoV2": {
"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"
},
"dueDate": {
"description": "Due date in ISO 8601 format",
"format": "date-time",
"type": "string"
},
"erpIdentificationFields": {
"additionalProperties": {
"type": "string"
},
"nullable": true,
"type": "object"
},
"externalId": {
"description": "Unique identifier of the document in the source data",
"minLength": 1,
"type": "string"
},
"issueDate": {
"description": "Issue date in ISO 8601 format",
"format": "date-time",
"type": "string"
},
"label": {
"description": "Label of the document",
"nullable": true,
"type": "string"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Additional metadata as a JSON Object",
"nullable": true,
"type": "object"
},
"proformaInvoiceNumber": {
"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",
"issueDate",
"proformaInvoiceNumber",
"status"
],
"title": "CreateProformaInvoice",
"type": "object"
},
"CreatePurchaseOrderDtoV2": {
"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",
"nullable": true,
"type": "string"
},
"dueDate": {
"description": "Due date in ISO 8601 format",
"format": "date-time",
"type": "string"
},
"erpIdentificationFields": {
"additionalProperties": {
"type": "string"
},
"nullable": true,
"type": "object"
},
"externalId": {
"description": "Unique identifier of the document in the source data",
"minLength": 1,
"type": "string"
},
"issueDate": {
"description": "Issue date in ISO 8601 format",
"format": "date-time",
"type": "string"
},
"label": {
"description": "Label of the document",
"nullable": true,
"type": "string"
},
"lineItems": {
"description": "Article line items of the purchase order. Optional.",
"items": {
"$ref": "#/components/schemas/PurchaseOrderLineItemDto"
},
"nullable": true,
"type": "array"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Additional metadata as a JSON Object",
"nullable": true,
"type": "object"
},
"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",
"issueDate",
"purchaseOrderNumber",
"status"
],
"title": "CreatePurchaseOrder",
"type": "object"
},
"CreateSalesOrderDtoV2": {
"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"
},
"dueDate": {
"description": "Due date in ISO 8601 format",
"format": "date-time",
"type": "string"
},
"erpIdentificationFields": {
"additionalProperties": {
"type": "string"
},
"nullable": true,
"type": "object"
},
"externalId": {
"description": "Unique identifier of the document in the source data",
"minLength": 1,
"type": "string"
},
"issueDate": {
"description": "Issue date in ISO 8601 format",
"format": "date-time",
"type": "string"
},
"label": {
"description": "Label of the document",
"nullable": true,
"type": "string"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Additional metadata as a JSON Object",
"nullable": true,
"type": "object"
},
"salesOrderNumber": {
"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",
"issueDate",
"salesOrderNumber",
"status"
],
"title": "CreateSalesOrder",
"type": "object"
},
"CreateSupplierCreditNoteDtoV2": {
"additionalProperties": false,
"properties": {
"accounting": {
"$ref": "#/components/schemas/AccountingDto"
},
"amounts": {
"$ref": "#/components/schemas/AmountsWithRemainingAmountDtoV2"
},
"counterParty": {
"$ref": "#/components/schemas/CounterPartyDtoV2"
},
"creditNoteNumber": {
"description": "Document number in the source data",
"minLength": 1,
"type": "string"
},
"currency": {
"description": "Currency code in ISO 4217 format",
"minLength": 1,
"type": "string"
},
"dueDate": {
"description": "Due date in ISO 8601 format",
"format": "date-time",
"nullable": true,
"type": "string"
},
"erpIdentificationFields": {
"additionalProperties": {
"type": "string"
},
"nullable": true,
"type": "object"
},
"externalId": {
"description": "Unique identifier of the document in the source data",
"minLength": 1,
"type": "string"
},
"issueDate": {
"description": "Issue date in ISO 8601 format",
"format": "date-time",
"type": "string"
},
"label": {
"description": "Label of the supplier credit note",
"nullable": true,
"type": "string"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Additional metadata as a JSON Object",
"nullab
# --- truncated at 32 KB (252 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/agicap/refs/heads/main/openapi/agicap-business-documents-v2-openapi.json