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

// @DataContract
export class BaseRequest
{
    /** @description 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 ApiKey: string;

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

    public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponseResult
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public StatusCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    public Login: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    public ErrorCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    public ErrorDisplayText: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    public ErrorMessage: string;

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

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public IpAddress: string;

    public constructor(init?: Partial<BaseResponseResult>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponse
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public Status: BaseResponseResult;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ApInvoiceResponse extends BaseResponse
{

    public constructor(init?: Partial<ApInvoiceResponse>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class ApObject
{
    // @DataMember
    public Po: string;

    // @DataMember
    public Data: string;

    public constructor(init?: Partial<ApObject>) { (Object as any).assign(this, init); }
}

/** @description ApInvoiceRequires active-e Supplier Connections.This endpoint takes AP/Invoices and/or AP ASNs. */
// @DataContract
export class ApInvoiceRequest extends BaseRequest
{
    // @DataMember
    public VendorId: string;

    // @DataMember
    public Invoices: ApObject[];

    // @DataMember
    public ASNs: ApObject[];

    public constructor(init?: Partial<ApInvoiceRequest>) { super(init); (Object as any).assign(this, init); }
}

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