Invoice Data Explained ​

The following is a list of data fields returned by the ACE360 Connect invoice endpoints. We've written this reference guide to help you better understand the data you receive from Connect.

Contents ​

• Id
• ApprenticeId
• InvoiceNumber
• PoNumber
• Reason
• OtherReason
• Paid
• InvoiceDate
• UserId
• CreatedBy
• CreatedByUserType
• CreatedAt
• UpdatedAt

id ​

Example:

"id": 20

This is the unique identifier for an invoice in ACE360.

apprenticeId ​

Example:

"apprenticeId": 200

invoiceNumber ​

Example:

"invoiceNumber": "12345"

poNumber ​

Example:

"poNumber": "AB789"

reason ​

Example:

"reason": "registration"

This field corresponds to the reason for an invoice or PO and can have the following enum values:

"registration"
"end_point_assessment"
"resit"
"component_resit"
"retake"
"appeal"
"other"

otherReason ​

Example:

"otherReason": "The other reason the invoice was created."

This field will contain an explanation when the 'reason' field is set to 'other'. If the reason field is set to any of the other enum values, this will return null.

paid ​

Example:

"paid": 0

Possible values: 0, 1

invoiceDate ​

Example:

"invoiceDate": "2024-02-19"

This field allows you to record the date that the invoice was raised.

Note that this is not necessarily the same date that the invoice record was created in ACE360, which is represented by the createdAt field.

The field is nullable and is formatted as YYYY-MM-DD.

userId ​

Example:

"userId": 10

This is the id of the user that created the invoice.

createdBy ​

Example:

"createdBy": "Melissa Gray"

This is the name of the user that created the invoice.

createdByUserType ​

Example:

"createdByUserType": "epao"

This is the organisation type of the user that created the invoice.

createdAt ​

Example:

"createdAt": "2024-02-19 11:00:59"

This is the date the invoice was created at.

updatedAt ​

Example:

"updatedAt": "2024-02-19 12:00:33"

This is the date the invoice was updated at.