Login to NexPortNexPort Solutions

PointOfSaleApi

Begins a new invoice.

post

Use the invoice id returned to start adding invoice items with the {M:NexportVirtualCampus.WebApi.v1.PointOfSaleApiController.AddInvoiceItem(Nexport.WebApi.Model.v1.CreateInvoiceItemRequest)} method. Once all items and payments are recorded use the {M:NexportVirtualCampus.WebApi.v1.PointOfSaleApiController.CommitInvoiceTransaction(Nexport.WebApi.Model.v1.CommitInvoiceRequest)} method to complete this invoice. ###Permissions Requires the Manage Invoices permission in the given organization or an ancestor. If a purchasing group is specified, the purchasing agent must have the Group Purchasing Agent permission in the given group or an ancestor.

Query parameters
access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Body

Contains fields for creating an invoice

purchasing_agent_idstring · uuidRequired

Id of the purchasing agent for the invoice. This must be a user id.

Example: 00000000-0000-0000-0000-000000000000
organization_idstring · uuidOptional

Id of the organization that the invoice belongs to. Usually this is the Organization that made the sale.

Example: 00000000-0000-0000-0000-000000000000
purchasing_group_idstring · uuidOptional

Id of the organization or group that is purchasing this wholesale. This must be the ID of a Group or Organization within your NexPort directory.

Example: 00000000-0000-0000-0000-000000000000
notestringOptional

Optional note for the invoice

Responses
200

Id of the created invoice

post
/api/v1/PointOfSaleApi/BeginInvoiceTransaction
POST /api/v1/PointOfSaleApi/BeginInvoiceTransaction?access_token=text HTTP/1.1
Host: www.nexportcampus.com
Content-Type: application/json
Accept: */*
Content-Length: 194

{
  "purchasing_agent_id": "00000000-0000-0000-0000-000000000000",
  "organization_id": "00000000-0000-0000-0000-000000000000",
  "purchasing_group_id": "00000000-0000-0000-0000-000000000000",
  "note": "text"
}
{
  "invoice_id": "00000000-0000-0000-0000-000000000000",
  "api_error_entity": {
    "error_code": 0,
    "error_message": "text",
    "warning_messages": [
      "text"
    ]
  }
}

Gets an invoice and it's list of invoice items'.

post
Query parameters
invoice_idstring · uuidRequired
access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Responses
200

Id of the created invoice

post
/api/v1/PointOfSaleApi/GetInvoice
POST /api/v1/PointOfSaleApi/GetInvoice?invoice_id=123e4567-e89b-12d3-a456-426614174000&access_token=text HTTP/1.1
Host: www.nexportcampus.com
Accept: */*

{
  "id": "00000000-0000-0000-0000-000000000000",
  "purchasing_agent": "00000000-0000-0000-0000-000000000000",
  "sales_agent": "00000000-0000-0000-0000-000000000000",
  "state": 0,
  "invoice_items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "product_id": "00000000-0000-0000-0000-000000000000",
      "purchasing_group_id": "00000000-0000-0000-0000-000000000000",
      "product_type": 0,
      "funding_pool": "text",
      "utc_redemption_available_date": "2025-11-30T23:02:48.993Z"
    }
  ],
  "utc_creation_date": "2025-11-30T23:02:48.993Z",
  "utc_date_committed": "2025-11-30T23:02:48.993Z",
  "api_error_entity": {
    "error_code": 0,
    "error_message": "text",
    "warning_messages": [
      "text"
    ]
  }
}

Gets the invoice item referenced by the provided invoice item id

post

Will returns the invioce item and its redemption ###Permissions Requires current user to be sales agent on the associated invoice OR current user to be purchasing agent on the invoice OR the Manage Invoices permission in the invoice item's invoice organization or an ancestor.

Query parameters
invoice_item_idstring · uuidRequired

ID of the invoice item to retrieve.

access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Responses
200

Id of the created invoice

post
/api/v1/PointOfSaleApi/GetInvoiceItem
POST /api/v1/PointOfSaleApi/GetInvoiceItem?invoice_item_id=123e4567-e89b-12d3-a456-426614174000&access_token=text HTTP/1.1
Host: www.nexportcampus.com
Accept: */*

{
  "invoice_item": {
    "id": "00000000-0000-0000-0000-000000000000",
    "product_id": "00000000-0000-0000-0000-000000000000",
    "purchasing_group_id": "00000000-0000-0000-0000-000000000000",
    "product_type": 0,
    "funding_pool": "text",
    "utc_redemption_available_date": "2025-11-30T23:02:48.993Z"
  },
  "invoice_item_redemption": {
    "redemption_id": "00000000-0000-0000-0000-000000000000",
    "invoice_item_id": "00000000-0000-0000-0000-000000000000",
    "invoice_id": "00000000-0000-0000-0000-000000000000",
    "redemption_type": 0,
    "redemption_enrollment_id": "00000000-0000-0000-0000-000000000000",
    "utc_redemption_date": "2025-11-30T23:02:48.993Z",
    "utc_expiration_date": "2025-11-30T23:02:48.993Z",
    "redemption_user_id": "00000000-0000-0000-0000-000000000000",
    "redemption_user_last_name": "text",
    "redemption_user_first_name": "text",
    "redemption_user_login": "text",
    "redemption_user_email": "text",
    "redemption_code": "text",
    "organization_id": "00000000-0000-0000-0000-000000000000",
    "organization_name": "text",
    "organization_short_name": "text",
    "catalog_id": "00000000-0000-0000-0000-000000000000",
    "catalog_name": "text",
    "catalog_description": "text",
    "catalog_pricing_model": 0,
    "catalog_access_time_limit": "text",
    "utc_catalog_creation_date": "2025-11-30T23:02:48.993Z",
    "utc_catalog_modified_date": "2025-11-30T23:02:48.993Z",
    "syllabus_id": "00000000-0000-0000-0000-000000000000",
    "syllabus_title": "text",
    "syllabus_unique_name": "text",
    "syllabus_description": "text",
    "syllabus_certificate_id": "00000000-0000-0000-0000-000000000000",
    "syllabus_disable_certificates_for_student": true,
    "syllabus_credit_hours": 1,
    "syllabus_section_number": "text",
    "syllabus_section_ceus": "text",
    "syllabus_section_duration": "text",
    "syllabus_section_objectives": "text",
    "utc_syllabus_creation_date": "2025-11-30T23:02:48.993Z",
    "utc_syllabus_modified_date": "2025-11-30T23:02:48.993Z",
    "api_error_entity": {
      "error_code": 0,
      "error_message": "text",
      "warning_messages": [
        "text"
      ]
    }
  },
  "api_error_entity": {
    "error_code": 0,
    "error_message": "text",
    "warning_messages": [
      "text"
    ]
  }
}

Creates a new invoice item and saves it to the database.

post

###Permissions Requires the current user to be the sales agent on the invoice. Also requires the current user to have the Add Subscriptions permission. If a purchasing group is specified, the purchasing agent must have the Group Purchasing Agent permission in the given group or an ancestor.

Query parameters
access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Body

Contains fields for creating an invoice item

invoice_idstring · uuidRequired

Id of the invoice to create an invoice item for

Example: 00000000-0000-0000-0000-000000000000
product_idstring · uuidRequired

ProductId from GetCatalog/CategorySyllabi

Example: 00000000-0000-0000-0000-000000000000
product_typeinteger · enumOptional

Default is Syllabus. Syllabus=0; Catalog=1; ShippingAndHandling=2; Taxes=3; Other=4; OpenEnded=5;0 = Syllabus, 1 = Catalog, 2 = ShippingAndHandling, 3 = Taxes, 4 = Other, 5 = OpenEnded

Possible values:
costnumberOptional

Cost in USD

notestringOptional

Invoice item note

utc_access_expiration_datestring · date-timeOptional

Can be used to set the redemption expiration date once a redemption is created for this invoice item. Redemption expiration will be set based on UtcAccessExpirationDate first if it is set.

access_expiration_time_limitstringOptional

Can be used to calculate the redemption expiration date once a redemption is created for this invoice item. Redemption will be set based on AccessExpirationTimeLimit if UtcAccessExpirationDate is not set. Redemption expiration date will be set to redemption date + AccessExpirationTimeLimit.

subscription_org_idstring · uuidOptional

Can be used to create the subscription within the specified organization for the student when the invoice item is redeemed. Enrollment associated with this invoice item will also be created for the subscription.

Example: 00000000-0000-0000-0000-000000000000
purchasing_group_idstring · uuidOptional

Used in wholesale purchases to associate invoice items with specific groups or orgs. This means the item was sold to the specified purchasing group. If no group is specified then the purchasing group from the invoice will be used.

Example: 00000000-0000-0000-0000-000000000000
group_membership_idsstring · uuid[]Optional

Can be used to create the membership within the specified groups for the student when the invoice item is redeemed.

funding_poolstringOptional

Used for organizations to group purchased items and track those groupings.

utc_redemption_available_datestring · date-timeOptional

Used to restrict when a redemption can be created for this invoice item, i.e. redemptions can't be created until after the specified date.

Responses
200

The id of the newly created invoice item

post
/api/v1/PointOfSaleApi/AddInvoiceItem
POST /api/v1/PointOfSaleApi/AddInvoiceItem?access_token=text HTTP/1.1
Host: www.nexportcampus.com
Content-Type: application/json
Accept: */*
Content-Length: 506

{
  "invoice_id": "00000000-0000-0000-0000-000000000000",
  "product_id": "00000000-0000-0000-0000-000000000000",
  "product_type": 0,
  "cost": 1,
  "note": "text",
  "utc_access_expiration_date": "2025-11-30T23:02:48.993Z",
  "access_expiration_time_limit": "text",
  "subscription_org_id": "00000000-0000-0000-0000-000000000000",
  "purchasing_group_id": "00000000-0000-0000-0000-000000000000",
  "group_membership_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "funding_pool": "text",
  "utc_redemption_available_date": "2025-11-30T23:02:48.993Z"
}
{
  "invoice_item_id": "00000000-0000-0000-0000-000000000000",
  "api_error_entity": {
    "error_code": 0,
    "error_message": "text",
    "warning_messages": [
      "text"
    ]
  }
}

Creates new invoice items of the given quantity and saves them to the database.

post

###Permissions Requires the current user to be the sales agent on the invoice. Also requires the current user to have the Add Subscriptions permission. If a purchasing group is specified, the purchasing agent must have the Group Purchasing Agent permission in the given group or an ancestor.

Query parameters
access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Body
quantityinteger · int32Optional

This is the number of invoice items to create with the same information.

invoice_idstring · uuidRequired

Id of the invoice to create an invoice item for

Example: 00000000-0000-0000-0000-000000000000
product_idstring · uuidRequired

ProductId from GetCatalog/CategorySyllabi

Example: 00000000-0000-0000-0000-000000000000
product_typeinteger · enumOptional

Default is Syllabus. Syllabus=0; Catalog=1; ShippingAndHandling=2; Taxes=3; Other=4; OpenEnded=5;0 = Syllabus, 1 = Catalog, 2 = ShippingAndHandling, 3 = Taxes, 4 = Other, 5 = OpenEnded

Possible values:
costnumberOptional

Cost in USD

notestringOptional

Invoice item note

utc_access_expiration_datestring · date-timeOptional

Can be used to set the redemption expiration date once a redemption is created for this invoice item. Redemption expiration will be set based on UtcAccessExpirationDate first if it is set.

access_expiration_time_limitstringOptional

Can be used to calculate the redemption expiration date once a redemption is created for this invoice item. Redemption will be set based on AccessExpirationTimeLimit if UtcAccessExpirationDate is not set. Redemption expiration date will be set to redemption date + AccessExpirationTimeLimit.

subscription_org_idstring · uuidOptional

Can be used to create the subscription within the specified organization for the student when the invoice item is redeemed. Enrollment associated with this invoice item will also be created for the subscription.

Example: 00000000-0000-0000-0000-000000000000
purchasing_group_idstring · uuidOptional

Used in wholesale purchases to associate invoice items with specific groups or orgs. This means the item was sold to the specified purchasing group. If no group is specified then the purchasing group from the invoice will be used.

Example: 00000000-0000-0000-0000-000000000000
group_membership_idsstring · uuid[]Optional

Can be used to create the membership within the specified groups for the student when the invoice item is redeemed.

funding_poolstringOptional

Used for organizations to group purchased items and track those groupings.

utc_redemption_available_datestring · date-timeOptional

Used to restrict when a redemption can be created for this invoice item, i.e. redemptions can't be created until after the specified date.

Responses
200

The list of ids for the newly created invoice items

post
/api/v1/PointOfSaleApi/AddInvoiceItems
POST /api/v1/PointOfSaleApi/AddInvoiceItems?access_token=text HTTP/1.1
Host: www.nexportcampus.com
Content-Type: application/json
Accept: */*
Content-Length: 519

{
  "quantity": 1,
  "invoice_id": "00000000-0000-0000-0000-000000000000",
  "product_id": "00000000-0000-0000-0000-000000000000",
  "product_type": 0,
  "cost": 1,
  "note": "text",
  "utc_access_expiration_date": "2025-11-30T23:02:48.993Z",
  "access_expiration_time_limit": "text",
  "subscription_org_id": "00000000-0000-0000-0000-000000000000",
  "purchasing_group_id": "00000000-0000-0000-0000-000000000000",
  "group_membership_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "funding_pool": "text",
  "utc_redemption_available_date": "2025-11-30T23:02:48.993Z"
}
{
  "invoice_item_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "api_error_entity": {
    "error_code": 0,
    "error_message": "text",
    "warning_messages": [
      "text"
    ]
  }
}

Creates a new invoice payment and adds it to the database. Requires the current user to be the sales agent on the invoice.

post
Query parameters
access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Body

Information for creating an invoice payment

invoice_idstring · uuidRequired

Id of the invoice that the payment is for

Example: 00000000-0000-0000-0000-000000000000
payment_collector_idstring · uuidOptional

Id of the user collecting payment (not used in 5.2; CurrentUser is used instead)

Example: 00000000-0000-0000-0000-000000000000
merchant_account_idstring · uuidRequired

Id of the account that the payment goes to

Example: 00000000-0000-0000-0000-000000000000
payee_idstring · uuidRequired

Id of user that payment is being collected from

Example: 00000000-0000-0000-0000-000000000000
payment_processorinteger · enumRequired

Cash=0; Check=1; PayPal=2; NopCommercePlugin=3; DiscountOrCoupon=4; Other=1000;0 = Cash, 1 = Check, 2 = PayPal, 3 = NopCommercePlugin, 4 = DiscountOrCoupon, 1000 = Other

Possible values:
payment_processor_transaction_idstringRequired

Id to help track the transaction information for the payment processor

amount_usdnumberRequired

Amount being paid

utc_payment_datestring · date-timeRequired

Date that the payment is made

notestringOptional

Optional note for the invoice payment

Responses
200

Id of the created invoice payment

post
/api/v1/PointOfSaleApi/AddInvoicePayment
POST /api/v1/PointOfSaleApi/AddInvoicePayment?access_token=text HTTP/1.1
Host: www.nexportcampus.com
Content-Type: application/json
Accept: */*
Content-Length: 365

{
  "invoice_id": "00000000-0000-0000-0000-000000000000",
  "payment_collector_id": "00000000-0000-0000-0000-000000000000",
  "merchant_account_id": "00000000-0000-0000-0000-000000000000",
  "payee_id": "00000000-0000-0000-0000-000000000000",
  "payment_processor": 0,
  "payment_processor_transaction_id": "text",
  "amount_usd": 1,
  "utc_payment_date": "2025-11-30T23:02:48.993Z",
  "note": "text"
}
{
  "invoice_payment_id": "00000000-0000-0000-0000-000000000000",
  "api_error_entity": {
    "error_code": 0,
    "error_message": "text",
    "warning_messages": [
      "text"
    ]
  }
}

Creates a new invoice scheduled payment and adds it to the database. Requires the current user to be the sales agent on the invoice.

post
Query parameters
access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Body

Information for creating an invoice scheduled payment

invoice_idstring · uuidRequired

Id of the invoice that the payment will be made to

Example: 00000000-0000-0000-0000-000000000000
amount_usdnumberOptional

Amount of the payment

utc_due_datestring · date-timeOptional

When the payment is due

notestringOptional

Optional note for the scheduled payment

Responses
200

Id of the created invoice scheduled payment

post
/api/v1/PointOfSaleApi/AddInvoiceScheduledPayment
POST /api/v1/PointOfSaleApi/AddInvoiceScheduledPayment?access_token=text HTTP/1.1
Host: www.nexportcampus.com
Content-Type: application/json
Accept: */*
Content-Length: 124

{
  "invoice_id": "00000000-0000-0000-0000-000000000000",
  "amount_usd": 1,
  "utc_due_date": "2025-11-30T23:02:48.993Z",
  "note": "text"
}
{
  "invoice_scheduled_payment_id": "00000000-0000-0000-0000-000000000000",
  "api_error_entity": {
    "error_code": 0,
    "error_message": "text",
    "warning_messages": [
      "text"
    ]
  }
}

This method is used to complete an invoice transaction that was started using {M:NexportVirtualCampus.WebApi.v1.PointOfSaleApiController.BeginInvoiceTransaction(Nexport.WebApi.Model.v1.CreateInvoiceMessageRequest)}.

post

This method is used to complete an invoice transaction that was started using {M:NexportVirtualCampus.WebApi.v1.PointOfSaleApiController.BeginInvoiceTransaction(Nexport.WebApi.Model.v1.CreateInvoiceMessageRequest)}. NOTE: the auto_redeem functionality has been superceded by the RedeemInvoiceItem method. Use that method instead of setting auto_redeem to true. ###Permissions Requires current user to be the sales agent on the invoice AND the Manage Invoices permission in the invoice organization or an ancestor.

Query parameters
access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Body

Contains information for committing an invoice and creating redemptions if necessary

invoice_idstring · uuidRequired

Id of the invoice to commit

Example: 00000000-0000-0000-0000-000000000000
Responses
200

Invoice number and redemption codes

post
/api/v1/PointOfSaleApi/CommitInvoiceTransaction
POST /api/v1/PointOfSaleApi/CommitInvoiceTransaction?access_token=text HTTP/1.1
Host: www.nexportcampus.com
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "invoice_id": "00000000-0000-0000-0000-000000000000"
}
{
  "invoice_redemption_code": "text",
  "invoice_item_redemption_codes": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "api_error_entity": {
    "error_code": 0,
    "error_message": "text",
    "warning_messages": [
      "text"
    ]
  }
}

Updates the invoice item associated with the invoice item id

post

###Permissions Requires current user to be sales agent on the associated invoice OR current user to have the Manage Invoices permission in the invoice organization or an ancestor thereof.

Query parameters
access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Body

Contains fields for redeeming an invoice item

invoice_item_idstring · uuidOptional

Id of the invoice item to update

Example: 00000000-0000-0000-0000-000000000000
Responses
200

Invoice redemption information

post
/api/v1/PointOfSaleApi/UpdateInvoiceItem
POST /api/v1/PointOfSaleApi/UpdateInvoiceItem?access_token=text HTTP/1.1
Host: www.nexportcampus.com
Content-Type: application/json
Accept: */*
Content-Length: 561

{
  "invoice_item_id": "00000000-0000-0000-0000-000000000000",
  "data": {
    "product_id": "00000000-0000-0000-0000-000000000000",
    "product_type": 0,
    "cost_usd": 1,
    "utc_access_expiration_date": "2025-11-30T23:02:48.993Z",
    "access_expiration_time_limit": "text",
    "note": "text",
    "product_code": "text",
    "is_renewal": true,
    "subscription_org_id": "00000000-0000-0000-0000-000000000000",
    "group_memberships": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "purchasing_group_id": "00000000-0000-0000-0000-000000000000",
    "funding_pool": "text",
    "utc_redemption_available_date": "2025-11-30T23:02:48.993Z"
  }
}
{
  "invoice_item_id": "00000000-0000-0000-0000-000000000000",
  "invoice_id": "00000000-0000-0000-0000-000000000000",
  "api_error_entity": {
    "error_code": 0,
    "error_message": "text",
    "warning_messages": [
      "text"
    ]
  }
}

Redeems the invoice item associated with the invoice item id or redemption id/code.

post

###Permissions Requires current user to be sales agent on the invoice OR current user to be purchasing agent on the invoice OR current user to have the Manage Invoices permission in the invoice organization or an ancestor thereof. In order to use the {M:NexportVirtualCampus.WebApi.v1.PointOfSaleApiController.ApplyInvoiceItemUpdates(Nexport.Models.PointOfSale.InvoiceItem,Nexport.WebApi.Model.v1.UpdatedInvoiceFields)} field the current user must be a sales gent or have manage invoices on the org. Purchasing agents can not update the invoice after the fact.

Query parameters
access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Body

Contains fields for redeeming an invoice item

invoice_item_idstring · uuidOptional

Id of the invoice item to redeem

Example: 00000000-0000-0000-0000-000000000000
redemption_idstring · uuidOptional

Id of the redemption to redeem

Example: 00000000-0000-0000-0000-000000000000
invoice_item_redemption_codestringOptional

Redemption code on the invoice item to redeem

redeeming_user_idstring · uuidRequired

Id of the user that is redeeming the invoice item

Example: 00000000-0000-0000-0000-000000000000
redemption_action_typeinteger · enumOptional

Renew redemption updates the expiration on an existing enrollment. Delete finished enrollment will also create a new enrollment. Default is normal redemption (creates an enrollment). NormalRedemption=1; DeleteFinishedEnrollment=20; RenewRedemption=30;0 = InvalidRedemption, 1 = NormalRedemption, 20 = DeleteFinishedEnrollment, 30 = RenewRedemption, 40 = RestartEnrollment

Possible values:
notestringOptional

Optional note to be included with the redemption creation audit log.

remote_system_namestringOptional

Name of the remote system redeeming the invoice item, i.e. "Marketplace".

redemption_admin_idstring · uuidOptional

Id of the admin who assigned the redemption. Will be set to current API user if not provided.

Example: 00000000-0000-0000-0000-000000000000
product_idstring · uuidRequired

ProductId from GetCatalog/CategorySyllabi

Example: 00000000-0000-0000-0000-000000000000
product_typeinteger · enumOptional

Default is Syllabus. Syllabus=0; Catalog=1; ShippingAndHandling=2; Taxes=3; Other=4; OpenEnded=5;0 = Syllabus, 1 = Catalog, 2 = ShippingAndHandling, 3 = Taxes, 4 = Other, 5 = OpenEnded

Possible values:
Responses
200

Invoice redemption information

post
/api/v1/PointOfSaleApi/RedeemInvoiceItem
POST /api/v1/PointOfSaleApi/RedeemInvoiceItem?access_token=text HTTP/1.1
Host: www.nexportcampus.com
Content-Type: application/json
Accept: */*
Content-Length: 923

{
  "invoice_item_id": "00000000-0000-0000-0000-000000000000",
  "redemption_id": "00000000-0000-0000-0000-000000000000",
  "invoice_item_redemption_code": "text",
  "redeeming_user_id": "00000000-0000-0000-0000-000000000000",
  "redemption_action_type": 0,
  "note": "text",
  "remote_system_name": "text",
  "redemption_admin_id": "00000000-0000-0000-0000-000000000000",
  "product_id": "00000000-0000-0000-0000-000000000000",
  "product_type": 0,
  "invoice_updates": {
    "product_id": "00000000-0000-0000-0000-000000000000",
    "product_type": 0,
    "cost_usd": 1,
    "utc_access_expiration_date": "2025-11-30T23:02:48.993Z",
    "access_expiration_time_limit": "text",
    "note": "text",
    "product_code": "text",
    "is_renewal": true,
    "subscription_org_id": "00000000-0000-0000-0000-000000000000",
    "group_memberships": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "purchasing_group_id": "00000000-0000-0000-0000-000000000000",
    "funding_pool": "text",
    "utc_redemption_available_date": "2025-11-30T23:02:48.993Z"
  }
}
{
  "redemption_id": "00000000-0000-0000-0000-000000000000",
  "invoice_item_id": "00000000-0000-0000-0000-000000000000",
  "invoice_id": "00000000-0000-0000-0000-000000000000",
  "redemption_type": 0,
  "redemption_enrollment_id": "00000000-0000-0000-0000-000000000000",
  "utc_redemption_date": "2025-11-30T23:02:48.993Z",
  "utc_expiration_date": "2025-11-30T23:02:48.993Z",
  "redemption_user_id": "00000000-0000-0000-0000-000000000000",
  "redemption_user_last_name": "text",
  "redemption_user_first_name": "text",
  "redemption_user_login": "text",
  "redemption_user_email": "text",
  "redemption_code": "text",
  "organization_id": "00000000-0000-0000-0000-000000000000",
  "organization_name": "text",
  "organization_short_name": "text",
  "catalog_id": "00000000-0000-0000-0000-000000000000",
  "catalog_name": "text",
  "catalog_description": "text",
  "catalog_pricing_model": 0,
  "catalog_access_time_limit": "text",
  "utc_catalog_creation_date": "2025-11-30T23:02:48.993Z",
  "utc_catalog_modified_date": "2025-11-30T23:02:48.993Z",
  "syllabus_id": "00000000-0000-0000-0000-000000000000",
  "syllabus_title": "text",
  "syllabus_unique_name": "text",
  "syllabus_description": "text",
  "syllabus_certificate_id": "00000000-0000-0000-0000-000000000000",
  "syllabus_disable_certificates_for_student": true,
  "syllabus_credit_hours": 1,
  "syllabus_section_number": "text",
  "syllabus_section_ceus": "text",
  "syllabus_section_duration": "text",
  "syllabus_section_objectives": "text",
  "utc_syllabus_creation_date": "2025-11-30T23:02:48.993Z",
  "utc_syllabus_modified_date": "2025-11-30T23:02:48.993Z",
  "api_error_entity": {
    "error_code": 0,
    "error_message": "text",
    "warning_messages": [
      "text"
    ]
  }
}

Resets the redemption and related enrollments on an Invoice Item

post

Deletes any existing redemption for an Invoice Item and creates a new one Any enrollments associated with the previous redemption will be expired. This includes enrollments made via catalog based invoice items. ###Permissions You must be the purchasing agent or the sales agent on the associated invoice OR you must have the manage invoices permission on the organization that owns this invoice.

Query parameters
access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Body
invoice_item_idstring · uuidRequired

Id of the invoice whose redemption is to be reset

Example: 00000000-0000-0000-0000-000000000000
notestringOptional

Optional note to be included with the redemption creation audit log.

remote_system_namestringOptional

Name of the remote system resetting the invoice item, i.e. "Marketplace".

redemption_reset_admin_idstring · uuidOptional

Id of the admin who assigned the redemption. Will be set to current Api user Id if not provided.

Example: 00000000-0000-0000-0000-000000000000
Responses
200

Redemption Successfully Deleted

post
/api/v1/PointOfSaleApi/ResetInvoiceRedemption
POST /api/v1/PointOfSaleApi/ResetInvoiceRedemption?access_token=text HTTP/1.1
Host: www.nexportcampus.com
Content-Type: application/json
Accept: */*
Content-Length: 167

{
  "invoice_item_id": "00000000-0000-0000-0000-000000000000",
  "note": "text",
  "remote_system_name": "text",
  "redemption_reset_admin_id": "00000000-0000-0000-0000-000000000000"
}
{
  "new-redemption": {
    "redemption_id": "00000000-0000-0000-0000-000000000000",
    "invoice_item_id": "00000000-0000-0000-0000-000000000000",
    "invoice_id": "00000000-0000-0000-0000-000000000000",
    "redemption_type": 0,
    "redemption_enrollment_id": "00000000-0000-0000-0000-000000000000",
    "utc_redemption_date": "2025-11-30T23:02:48.993Z",
    "utc_expiration_date": "2025-11-30T23:02:48.993Z",
    "redemption_user_id": "00000000-0000-0000-0000-000000000000",
    "redemption_user_last_name": "text",
    "redemption_user_first_name": "text",
    "redemption_user_login": "text",
    "redemption_user_email": "text",
    "redemption_code": "text",
    "organization_id": "00000000-0000-0000-0000-000000000000",
    "organization_name": "text",
    "organization_short_name": "text",
    "catalog_id": "00000000-0000-0000-0000-000000000000",
    "catalog_name": "text",
    "catalog_description": "text",
    "catalog_pricing_model": 0,
    "catalog_access_time_limit": "text",
    "utc_catalog_creation_date": "2025-11-30T23:02:48.993Z",
    "utc_catalog_modified_date": "2025-11-30T23:02:48.993Z",
    "syllabus_id": "00000000-0000-0000-0000-000000000000",
    "syllabus_title": "text",
    "syllabus_unique_name": "text",
    "syllabus_description": "text",
    "syllabus_certificate_id": "00000000-0000-0000-0000-000000000000",
    "syllabus_disable_certificates_for_student": true,
    "syllabus_credit_hours": 1,
    "syllabus_section_number": "text",
    "syllabus_section_ceus": "text",
    "syllabus_section_duration": "text",
    "syllabus_section_objectives": "text",
    "utc_syllabus_creation_date": "2025-11-30T23:02:48.993Z",
    "utc_syllabus_modified_date": "2025-11-30T23:02:48.993Z",
    "api_error_entity": {
      "error_code": 0,
      "error_message": "text",
      "warning_messages": [
        "text"
      ]
    }
  },
  "invoice-item": {
    "id": "00000000-0000-0000-0000-000000000000",
    "product_id": "00000000-0000-0000-0000-000000000000",
    "purchasing_group_id": "00000000-0000-0000-0000-000000000000",
    "product_type": 0,
    "funding_pool": "text",
    "utc_redemption_available_date": "2025-11-30T23:02:48.993Z"
  },
  "api_error_entity": {
    "error_code": 0,
    "error_message": "text",
    "warning_messages": [
      "text"
    ]
  }
}

Gets the invoice redemption information corresponding to the given id.

get

Gets the invoice redemption information corresponding to the given invoice item. ###Permissions Requires current user to be sales agent on the invoice OR current user to be purchasing agent on the invoice OR the Manage Invoices permission in the invoice item's invoice organization or an ancestor.

Query parameters
invoice_item_idstring · uuidRequired
access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Responses
200

Invoice redemption information

get
/api/v1/PointOfSaleApi/GetInvoiceRedemption
GET /api/v1/PointOfSaleApi/GetInvoiceRedemption?invoice_item_id=123e4567-e89b-12d3-a456-426614174000&access_token=text HTTP/1.1
Host: www.nexportcampus.com
Accept: */*

{
  "redemption_id": "00000000-0000-0000-0000-000000000000",
  "invoice_item_id": "00000000-0000-0000-0000-000000000000",
  "invoice_id": "00000000-0000-0000-0000-000000000000",
  "redemption_type": 0,
  "redemption_enrollment_id": "00000000-0000-0000-0000-000000000000",
  "utc_redemption_date": "2025-11-30T23:02:48.993Z",
  "utc_expiration_date": "2025-11-30T23:02:48.993Z",
  "redemption_user_id": "00000000-0000-0000-0000-000000000000",
  "redemption_user_last_name": "text",
  "redemption_user_first_name": "text",
  "redemption_user_login": "text",
  "redemption_user_email": "text",
  "redemption_code": "text",
  "organization_id": "00000000-0000-0000-0000-000000000000",
  "organization_name": "text",
  "organization_short_name": "text",
  "catalog_id": "00000000-0000-0000-0000-000000000000",
  "catalog_name": "text",
  "catalog_description": "text",
  "catalog_pricing_model": 0,
  "catalog_access_time_limit": "text",
  "utc_catalog_creation_date": "2025-11-30T23:02:48.993Z",
  "utc_catalog_modified_date": "2025-11-30T23:02:48.993Z",
  "syllabus_id": "00000000-0000-0000-0000-000000000000",
  "syllabus_title": "text",
  "syllabus_unique_name": "text",
  "syllabus_description": "text",
  "syllabus_certificate_id": "00000000-0000-0000-0000-000000000000",
  "syllabus_disable_certificates_for_student": true,
  "syllabus_credit_hours": 1,
  "syllabus_section_number": "text",
  "syllabus_section_ceus": "text",
  "syllabus_section_duration": "text",
  "syllabus_section_objectives": "text",
  "utc_syllabus_creation_date": "2025-11-30T23:02:48.993Z",
  "utc_syllabus_modified_date": "2025-11-30T23:02:48.993Z",
  "api_error_entity": {
    "error_code": 0,
    "error_message": "text",
    "warning_messages": [
      "text"
    ]
  }
}
PreviousLearningApiNextPostmanApi

Last updated