AIM Web Services

<back to all web services

ApInvoiceRequest

ApInvoice
Requires active-e Supplier Connections.
This endpoint takes AP/Invoices and/or AP ASNs.

The following routes are available for this service:
POST/api/ApInvoice
import Foundation
import ServiceStack

/**
* ApInvoiceRequires active-e Supplier Connections.This endpoint takes AP/Invoices and/or AP ASNs.
*/
// @DataContract
public class ApInvoiceRequest : BaseRequest
{
    // @DataMember
    public var vendorId:String

    // @DataMember
    public var invoices:[ApObject] = []

    // @DataMember
    public var asNs:[ApObject] = []

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case vendorId
        case invoices
        case asNs
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        vendorId = try container.decodeIfPresent(String.self, forKey: .vendorId)
        invoices = try container.decodeIfPresent([ApObject].self, forKey: .invoices) ?? []
        asNs = try container.decodeIfPresent([ApObject].self, forKey: .asNs) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if vendorId != nil { try container.encode(vendorId, forKey: .vendorId) }
        if invoices.count > 0 { try container.encode(invoices, forKey: .invoices) }
        if asNs.count > 0 { try container.encode(asNs, forKey: .asNs) }
    }
}

// @DataContract
public class BaseRequest : Codable
{
    /**
    * This is your AIM API Key provided by Tri-Tech
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
    public var apiKey:String

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    public var oAuthToken:String

    required public init(){}
}

// @DataContract
public class ApObject : Codable
{
    // @DataMember
    public var po:String

    // @DataMember
    public var data:String

    required public init(){}
}

// @DataContract
public class ApInvoiceResponse : BaseResponse
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

// @DataContract
public class BaseResponse : Codable
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public var status:BaseResponseResult

    required public init(){}
}

// @DataContract
public class BaseResponseResult : Codable
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public var statusCode:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    public var login:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    public var errorCode:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    public var errorDisplayText:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    public var errorMessage:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    public var domainName:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public var ipAddress:String

    required public init(){}
}

Swift ApInvoiceRequest 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.

POST /api/ApInvoice HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ApInvoiceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <ASNs>
    <ApInvoiceRequest.ApObject>
      <Data>String</Data>
      <Po>String</Po>
    </ApInvoiceRequest.ApObject>
  </ASNs>
  <Invoices>
    <ApInvoiceRequest.ApObject>
      <Data>String</Data>
      <Po>String</Po>
    </ApInvoiceRequest.ApObject>
  </Invoices>
  <VendorId>String</VendorId>
</ApInvoiceRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ApInvoiceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <Status>
    <DomainName>String</DomainName>
    <ErrorCode>String</ErrorCode>
    <ErrorDisplayText>String</ErrorDisplayText>
    <ErrorMessage>String</ErrorMessage>
    <IpAddress>String</IpAddress>
    <Login>String</Login>
    <StatusCode>String</StatusCode>
  </Status>
</ApInvoiceResponse>