POST api/Invoice

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
APIKey	string	Required
ClientId	string	Required
Id	globally unique identifier	None.
PONumber	string	None.
BatchNumber	string	None.
InvoiceDate	date	None.
Customer	Customer	None.
Address	Address	None.
Orders	Orders	None.
Contributions	Contributions	None.
Memberships	Memberships	None.
Payment	Payment	None.
Meeting	Meeting	None.
GiftCertificates	GiftCertificates	None.
Freight	Freight	None.
ProcessInvoice	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "APIKey": "sample string 1",
  "ClientId": "sample string 2",
  "Id": "8bb9a7f5-8924-4035-a2f4-a63145f100d7",
  "PONumber": "sample string 4",
  "BatchNumber": "sample string 5",
  "InvoiceDate": "2024-11-21T09:03:51.3950219+00:00",
  "Customer": {
    "ContactNumber": "sample string 1",
    "AccountNumber": "sample string 2",
    "AccountName": "sample string 3",
    "ParentCustomer": {
      "Type": 1,
      "Id": "8ddcbbf5-ae5b-447b-bc03-00e7dafa9a0a",
      "Number": "sample string 2",
      "Name": "sample string 3"
    },
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "Address1": "sample string 6",
    "Address2": "sample string 7",
    "Address3": "sample string 8",
    "City": "sample string 9",
    "State": "sample string 10",
    "PostalCode": "sample string 11",
    "Country": "sample string 12",
    "Phone": "sample string 13",
    "Fax": "sample string 14",
    "Email": "sample string 15"
  },
  "Address": {
    "Billing": {
      "BillTo_Name": "sample string 1",
      "BillTo_Address1": "sample string 2",
      "BillTo_Address2": "sample string 3",
      "BillTo_Address3": "sample string 4",
      "BillTo_City": "sample string 5",
      "BillTo_State": "sample string 6",
      "BillTo_PostalCode": "sample string 7",
      "BillTo_Country": "sample string 8",
      "BillTo_Phone": "sample string 9",
      "BillTo_Fax": "sample string 10",
      "BillTo_Email": "sample string 11"
    },
    "Shipping": {
      "ShipTo_Name": "sample string 1",
      "ShipTo_Address1": "sample string 2",
      "ShipTo_Address2": "sample string 3",
      "ShipTo_Address3": "sample string 4",
      "ShipTo_City": "sample string 5",
      "ShipTo_State": "sample string 6",
      "ShipTo_PostalCode": "sample string 7",
      "ShipTo_Country": "sample string 8",
      "ShipTo_Phone": "sample string 9",
      "ShipTo_Fax": "sample string 10",
      "ShipTo_Email": "sample string 11"
    }
  },
  "Orders": {
    "Order": [
      {
        "Code": "sample string 1",
        "Qty": 2,
        "Price": 3.0,
        "AdditionalInfo": "sample string 4",
        "PromoCode": "sample string 5"
      },
      {
        "Code": "sample string 1",
        "Qty": 2,
        "Price": 3.0,
        "AdditionalInfo": "sample string 4",
        "PromoCode": "sample string 5"
      }
    ]
  },
  "Contributions": {
    "Contribution": [
      {
        "Code": "sample string 1",
        "Qty": 2,
        "Price": 3.0,
        "AdditionalInfo": "sample string 4"
      },
      {
        "Code": "sample string 1",
        "Qty": 2,
        "Price": 3.0,
        "AdditionalInfo": "sample string 4"
      }
    ]
  },
  "Memberships": {
    "Membership": [
      {
        "Rate": "b3480686-3b89-4feb-ab0a-128a7f188d4c",
        "Volume": "sample string 2",
        "Price": 3.0,
        "CycleStartDate": "2024-11-21T09:03:51.4106501+00:00",
        "PromoCode": "sample string 5"
      },
      {
        "Rate": "b3480686-3b89-4feb-ab0a-128a7f188d4c",
        "Volume": "sample string 2",
        "Price": 3.0,
        "CycleStartDate": "2024-11-21T09:03:51.4106501+00:00",
        "PromoCode": "sample string 5"
      }
    ]
  },
  "Payment": {
    "PaymentType": "sample string 1",
    "CreditCardNumber": "sample string 2",
    "CreditCardExpiration": "sample string 3",
    "CVV2": "sample string 4",
    "PaymentAmount": 5.0,
    "NameOnCard": "sample string 6",
    "Payment_Address1": "sample string 7",
    "Payment_Address2": "sample string 8",
    "Payment_City": "sample string 9",
    "Payment_State": "sample string 10",
    "Payment_PostalCode": "sample string 11",
    "Payment_Country": "sample string 12",
    "Payment_Telephone": "sample string 13",
    "Authorization_OriginalId": "sample string 14",
    "Authorization_ResultCode": "sample string 15",
    "Authorization_AuthCode": "sample string 16",
    "Authorization_Message": "sample string 17"
  },
  "Meeting": {
    "EventCode": "sample string 1",
    "RegistrationCode": "sample string 2",
    "SessionCodes": "sample string 3",
    "PromoCode": "sample string 4"
  },
  "GiftCertificates": {
    "GiftCertificate": [
      {
        "Code": "sample string 1",
        "Price": 2.0
      },
      {
        "Code": "sample string 1",
        "Price": 2.0
      }
    ]
  },
  "Freight": {
    "Code": "sample string 1",
    "Price": 2.0,
    "Tax": 3.0
  },
  "ProcessInvoice": true
}

application/xml, text/xml

Sample:

<InvoiceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Protech.UX.API.Invoice">
  <APIKey>sample string 1</APIKey>
  <Address>
    <Billing>
      <BillTo_Address1>sample string 2</BillTo_Address1>
      <BillTo_Address2>sample string 3</BillTo_Address2>
      <BillTo_Address3>sample string 4</BillTo_Address3>
      <BillTo_City>sample string 5</BillTo_City>
      <BillTo_Country>sample string 8</BillTo_Country>
      <BillTo_Email>sample string 11</BillTo_Email>
      <BillTo_Fax>sample string 10</BillTo_Fax>
      <BillTo_Name>sample string 1</BillTo_Name>
      <BillTo_Phone>sample string 9</BillTo_Phone>
      <BillTo_PostalCode>sample string 7</BillTo_PostalCode>
      <BillTo_State>sample string 6</BillTo_State>
    </Billing>
    <Shipping>
      <ShipTo_Address1>sample string 2</ShipTo_Address1>
      <ShipTo_Address2>sample string 3</ShipTo_Address2>
      <ShipTo_Address3>sample string 4</ShipTo_Address3>
      <ShipTo_City>sample string 5</ShipTo_City>
      <ShipTo_Country>sample string 8</ShipTo_Country>
      <ShipTo_Email>sample string 11</ShipTo_Email>
      <ShipTo_Fax>sample string 10</ShipTo_Fax>
      <ShipTo_Name>sample string 1</ShipTo_Name>
      <ShipTo_Phone>sample string 9</ShipTo_Phone>
      <ShipTo_PostalCode>sample string 7</ShipTo_PostalCode>
      <ShipTo_State>sample string 6</ShipTo_State>
    </Shipping>
  </Address>
  <BatchNumber>sample string 5</BatchNumber>
  <ClientId>sample string 2</ClientId>
  <Contributions>
    <Contribution>
      <Contribution>
        <AdditionalInfo>sample string 4</AdditionalInfo>
        <Code>sample string 1</Code>
        <Price>3</Price>
        <Qty>2</Qty>
      </Contribution>
      <Contribution>
        <AdditionalInfo>sample string 4</AdditionalInfo>
        <Code>sample string 1</Code>
        <Price>3</Price>
        <Qty>2</Qty>
      </Contribution>
    </Contribution>
  </Contributions>
  <Customer>
    <AccountName>sample string 3</AccountName>
    <AccountNumber>sample string 2</AccountNumber>
    <Address1>sample string 6</Address1>
    <Address2>sample string 7</Address2>
    <Address3>sample string 8</Address3>
    <City>sample string 9</City>
    <ContactNumber>sample string 1</ContactNumber>
    <Country>sample string 12</Country>
    <Email>sample string 15</Email>
    <Fax>sample string 14</Fax>
    <FirstName>sample string 4</FirstName>
    <LastName>sample string 5</LastName>
    <ParentCustomer xmlns:d3p1="http://schemas.datacontract.org/2004/07/Protech.UX.API.Contact">
      <d3p1:Id>8ddcbbf5-ae5b-447b-bc03-00e7dafa9a0a</d3p1:Id>
      <d3p1:Name>sample string 3</d3p1:Name>
      <d3p1:Number>sample string 2</d3p1:Number>
      <d3p1:Type>account</d3p1:Type>
    </ParentCustomer>
    <Phone>sample string 13</Phone>
    <PostalCode>sample string 11</PostalCode>
    <State>sample string 10</State>
  </Customer>
  <Freight>
    <Code>sample string 1</Code>
    <Price>2</Price>
    <Tax>3</Tax>
  </Freight>
  <GiftCertificates>
    <GiftCertificate>
      <GiftCertificate>
        <Code>sample string 1</Code>
        <Price>2</Price>
      </GiftCertificate>
      <GiftCertificate>
        <Code>sample string 1</Code>
        <Price>2</Price>
      </GiftCertificate>
    </GiftCertificate>
  </GiftCertificates>
  <Id>8bb9a7f5-8924-4035-a2f4-a63145f100d7</Id>
  <InvoiceDate>2024-11-21T09:03:51.3950219+00:00</InvoiceDate>
  <Meeting>
    <EventCode>sample string 1</EventCode>
    <PromoCode>sample string 4</PromoCode>
    <RegistrationCode>sample string 2</RegistrationCode>
    <SessionCodes>sample string 3</SessionCodes>
  </Meeting>
  <Memberships>
    <Membership>
      <Membership>
        <CycleStartDate>2024-11-21T09:03:51.4106501+00:00</CycleStartDate>
        <Price>3</Price>
        <PromoCode>sample string 5</PromoCode>
        <Rate>b3480686-3b89-4feb-ab0a-128a7f188d4c</Rate>
        <Volume>sample string 2</Volume>
      </Membership>
      <Membership>
        <CycleStartDate>2024-11-21T09:03:51.4106501+00:00</CycleStartDate>
        <Price>3</Price>
        <PromoCode>sample string 5</PromoCode>
        <Rate>b3480686-3b89-4feb-ab0a-128a7f188d4c</Rate>
        <Volume>sample string 2</Volume>
      </Membership>
    </Membership>
  </Memberships>
  <Orders>
    <Order>
      <Order>
        <AdditionalInfo>sample string 4</AdditionalInfo>
        <Code>sample string 1</Code>
        <Price>3</Price>
        <PromoCode>sample string 5</PromoCode>
        <Qty>2</Qty>
      </Order>
      <Order>
        <AdditionalInfo>sample string 4</AdditionalInfo>
        <Code>sample string 1</Code>
        <Price>3</Price>
        <PromoCode>sample string 5</PromoCode>
        <Qty>2</Qty>
      </Order>
    </Order>
  </Orders>
  <PONumber>sample string 4</PONumber>
  <Payment>
    <Authorization_AuthCode>sample string 16</Authorization_AuthCode>
    <Authorization_Message>sample string 17</Authorization_Message>
    <Authorization_OriginalId>sample string 14</Authorization_OriginalId>
    <Authorization_ResultCode>sample string 15</Authorization_ResultCode>
    <CVV2>sample string 4</CVV2>
    <CreditCardExpiration>sample string 3</CreditCardExpiration>
    <CreditCardNumber>sample string 2</CreditCardNumber>
    <NameOnCard>sample string 6</NameOnCard>
    <PaymentAmount>5</PaymentAmount>
    <PaymentType>sample string 1</PaymentType>
    <Payment_Address1>sample string 7</Payment_Address1>
    <Payment_Address2>sample string 8</Payment_Address2>
    <Payment_City>sample string 9</Payment_City>
    <Payment_Country>sample string 12</Payment_Country>
    <Payment_PostalCode>sample string 11</Payment_PostalCode>
    <Payment_State>sample string 10</Payment_State>
    <Payment_Telephone>sample string 13</Payment_Telephone>
  </Payment>
  <ProcessInvoice>true</ProcessInvoice>
</InvoiceRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

APIResponse

Name	Type	Additional information
Status	Status	None.
Id	globally unique identifier	None.
Description	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Status": 0,
  "Id": "bdde3000-90d7-45dc-8861-b8270b909328",
  "Description": "sample string 2"
}

application/xml, text/xml

Sample:

<APIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Protech.UX.API.Response">
  <Description>sample string 2</Description>
  <Id>bdde3000-90d7-45dc-8861-b8270b909328</Id>
  <Status>Success</Status>
</APIResponse>