Prepayment on a Campaign

Use this to attach a prepayment record on the campaign.

Prepayments can only be added to campaigns which are in reserved or confirmed status. When it is still a quote, Prepayment is not permitted, and once invoicing has completed, then payments should be applied to Invoices and not to the Campaign. If the invoice has started, but there are still more invoices to be generated, it is ok to apply prepayments to the campaign for application on future invoices.

Payload for this will look like this - with the most important ones to know about highlighted below. (these are the fields in use when Naviga Propel imports a prepayment with a campaign to Naviga Ad). There are additional fields in swagger, but I have only included here the ones most commonly used.

{
  "Type": "string",
  "BankCode": "string",
  "DepositDate": "2026-01-30",
  "CheckID": "string",
  "Amount": 0,
  "AmountApplied": 0,
  "ExternalCardNumber": "string",
}

Field	Description	Required?
Type	This is the payment Type. Valid Options here include: CA=Cash CC=Credit Card CK=Check Please note - if this is adding a credit card prepayment to a campaign and the credit card was taken already in another system, it is recommended that you use Cash or Check for this as the Naviga Payment type instead of credit card, since Naviga would not be the system to initiate a refund, it really is a cash payment to Naviga.	Yes
BankCode	This is the ID used in Bank Setup in Naviga Ad (Setup -> System Tables Setup -> Bank Setup)	Yes
DepositDate	This is the date of the deposit formatted as yyyy-mm-dd	Yes
CheckID	If this is a check payment above, this is the check number. It will be displayed on the campaign as the "Reference Number" and it will be a hyperlink to the payment details screen.	Yes, for a check payment No for other payment types
Amount	This is the amount of the payment.	Yes
AmountApplied	If you are billing this campaign using Naviga Ad Billing processes, this will likely be 0, or simply left off the payload. If you put an amount in here, then the billing process will see it as already applied and will not apply it again and the client will see a balance on their invoice. As an example, the $100 payment below has already been applied, the $200 is attached to the campaign but is pending application by the billing process.	No
ExternalCardNumber	This should be filled in with a masked card number to display onscreen. This is helpful to the end user to be able to reference in communication with a client. Even if the Payment type is Cash or Check, this can still be filled in. For card payments taken and managed in another system, it is recommended to add it in Naviga as a Cash payment if we aren't the ones actually charging the card.	No, but helpful to convey to the user a number for cross referencing

The response returned from the system will look like this:

{
  "ID": "string",
  "InternalRef": "string"
}

The internal ref is the important/useful one. It will display the customer's account number*the payment ID, like this:

"InternalRef": "100005*1202.AUTO"

In this example the customer account ID is 100005 and the payment reference number is 1202.AUTO

The ID is simply the numeric count for the prepayment within the campaign, so you will see sequential numbers here if there are multiple payments prepaying the campaign. Nothing visible to a user looking at the campaign later.