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
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class InvoiceRecordPaymentRequest
    {
        public UUID InvoiceUID = null;
        public String StripeToken = null;
        
        public UUID getInvoiceUID() { return InvoiceUID; }
        public InvoiceRecordPaymentRequest setInvoiceUID(UUID value) { this.InvoiceUID = value; return this; }
        public String getStripeToken() { return StripeToken; }
        public InvoiceRecordPaymentRequest setStripeToken(String value) { this.StripeToken = value; return this; }
    }

    public static class InvoiceRecordPaymentResponse
    {
        public ResponseStatus ResponseStatus = null;
        public Boolean Success = null;
        public Boolean Paid = null;
        public String ReceiptUrl = null;
        public String Message = null;
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public InvoiceRecordPaymentResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public Boolean isSuccess() { return Success; }
        public InvoiceRecordPaymentResponse setSuccess(Boolean value) { this.Success = value; return this; }
        public Boolean isPaid() { return Paid; }
        public InvoiceRecordPaymentResponse setPaid(Boolean value) { this.Paid = value; return this; }
        public String getReceiptUrl() { return ReceiptUrl; }
        public InvoiceRecordPaymentResponse setReceiptUrl(String value) { this.ReceiptUrl = value; return this; }
        public String getMessage() { return Message; }
        public InvoiceRecordPaymentResponse setMessage(String value) { this.Message = value; return this; }
    }

}

Java InvoiceRecordPaymentRequest DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<InvoiceRecordPaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <InvoiceUID>00000000-0000-0000-0000-000000000000</InvoiceUID>
  <StripeToken>String</StripeToken>
</InvoiceRecordPaymentRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<InvoiceRecordPaymentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Message>String</Message>
  <Paid>false</Paid>
  <ReceiptUrl>String</ReceiptUrl>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Success>false</Success>
</InvoiceRecordPaymentResponse>