Trendsic Platform Service

<back to all web services

InvoiceRecordPaymentRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
PUT,OPTIONS/v1/invoice/{InvoiceUID}/payment
"use strict";
export class InvoiceRecordPaymentResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Success?:boolean,Paid?:boolean,ReceiptUrl?:string,Message?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {boolean} */
    Success;
    /** @type {boolean} */
    Paid;
    /** @type {string} */
    ReceiptUrl;
    /** @type {string} */
    Message;
}
export class InvoiceRecordPaymentRequest {
    /** @param {{InvoiceUID?:string,StripeToken?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    InvoiceUID;
    /** @type {string} */
    StripeToken;
}

JavaScript InvoiceRecordPaymentRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /v1/invoice/{InvoiceUID}/payment HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	InvoiceUID: 00000000000000000000000000000000,
	StripeToken: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Success: False,
	Paid: False,
	ReceiptUrl: String,
	Message: String
}