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
"use strict";
export class BaseRequest {
    /** @param {{ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description This is your AIM API Key provided by Tri-Tech */
    ApiKey;
    /** @type {string} */
    OAuthToken;
}
export class BaseResponseResult {
    /** @param {{StatusCode?:string,Login?:string,ErrorCode?:string,ErrorDisplayText?:string,ErrorMessage?:string,DomainName?:string,IpAddress?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    StatusCode;
    /** @type {string} */
    Login;
    /** @type {string} */
    ErrorCode;
    /** @type {string} */
    ErrorDisplayText;
    /** @type {string} */
    ErrorMessage;
    /** @type {string} */
    DomainName;
    /** @type {string} */
    IpAddress;
}
export class BaseResponse {
    /** @param {{Status?:BaseResponseResult}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {BaseResponseResult} */
    Status;
}
export class ApInvoiceResponse extends BaseResponse {
    /** @param {{Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class ApObject {
    /** @param {{Po?:string,Data?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Po;
    /** @type {string} */
    Data;
}
export class ApInvoiceRequest extends BaseRequest {
    /** @param {{VendorId?:string,Invoices?:ApObject[],ASNs?:ApObject[],ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    VendorId;
    /** @type {ApObject[]} */
    Invoices;
    /** @type {ApObject[]} */
    ASNs;
}

JavaScript 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>