academyFIVE API Beta icon

academyFIVE API Beta

Interact with academyFIVE API

Actions482

Invoices → Create invoice

AI-generated

Summary

Create an academyFIVE invoice by sending the configured invoice data and attributes to the API. Supply the required billing details and at least one invoice position; optional fields can set enrollment triggers, payment plans, comments, and accounting details.

Inputs

  • data.type — Optional type value included in the request body.
  • data.attributes.profileId — Profile ID associated with the invoice.
  • data.attributes.bookingId — Booking ID associated with the invoice.
  • data.attributes.isTriggerMatriculation — Whether to trigger matriculation.
  • data.attributes.isTriggerReRegistration — Whether to trigger re-registration.
  • data.attributes.matriculationDateType — Matriculation date selection: 1 for cohort start date or 2 for semester start date.
  • data.attributes.semesterId — Semester ID.
  • data.attributes.companyId — Company ID.
  • data.attributes.addressId (required) — Address ID for the invoice.
  • data.attributes.bankAccountId (required) — Bank account ID for the invoice.
  • data.attributes.currencyCode (required) — Invoice currency code.
  • data.attributes.documentId (required) — Document ID for the invoice.
  • data.attributes.invoiceDate (required) — Invoice date.
  • data.attributes.invoicePositions (required) — One or more invoice positions. Each requires positionPrice, positionQuantity, and positionTaxId; positionComment, positionProfitCenterId, and positionRevenueAccountId are optional.
  • data.attributes.siteId (required) — Site ID for the invoice.
  • data.attributes.comment — Invoice comment.
  • data.attributes.confirmationOfPaymentDocumentId — Confirmation-of-payment document ID.
  • data.attributes.dueDate — Invoice due date.
  • data.attributes.isPaymentPlan — Whether the invoice uses a payment plan.
  • data.attributes.paymentPlanCount — Number of payment plan installments.
  • data.attributes.paymentPlanDueDate — Payment plan due date; the field description says it defaults to 30 days if left empty.
  • data.attributes.profitCenterId — Profit center ID.
  • data.attributes.showRecipient — Whether to show the recipient.

Output shape

A list of JSON items returned by the API, paired with their corresponding input item.

If continue-on-fail is enabled, an item-level error object is returned for failed requests. The source sends populated parameters as the request body and uses the configured academyFIVE API credentials.

Links

Discussion