PostAccountsPayable4_0

This method is to be used to post invoice records in ResMan for a given property.

Request

Data is added by performing a HTTP Post to https://api.myresman.com/MITS/PostAccountsPayable4_0  supplying the listed parameters below.  

Parameters

The following demonstrates one way of submitting a request to the PostAccountsPayable4_0 method using C#.

NameValueCollection postData = new NameValueCollection();

// Integration Partner values

postData["IntegrationPartnerID"] = "1000";

postData["ApiKey"] = "6aw7y9m3m04849lqld6em9sudl5fg01u";                                      

// Account and property specific data

postData["AccountID"] = "400";

postData["PropertyID"] = "07413576-f764-44c6-be35-df4139deec01";

// Method specific parameters

postData["Xml"] = “<AccountsPayable>...</AccountsPayable>”;

string url = "https://api.myresman.com/MITS/PostAccountsPayable4_0";

WebClient client = new WebClient();                

byte[] response = client.UploadValues(url, "POST", postData);

string strResponse = System.Text.Encoding.Default.GetString(response);

Posting Xml Parameter

Below is example XML following the MITS Accounts Payable 4.0 standard  to create a new invoice record.  Please note the following requirements:

Vendor Node

• The Vendor > ActionType node must be InvoicePayment.  ResMan does not currently support adding or updating of vendor records through the API.
• The Vendor > IdRef node must match an existing Vendor Abbreviation as entered into ResMan by the client.

Invoice Node

• The Invoice > IdRef node must contain the Invoice Number as specified on the vendor’s invoice (as per the MITS standard)
• The Invoice > ImageNumber node can contain a url to the digital version of the invoice.

• The Invoice > AccountingDate node is optional. If not supplied, will default to Invoice > InvoiceDate.

InvoiceDetails Node

• The InvoiceDetail > AccountIdentifier node must match an existing GL Account Number as entered into ResMan by the client.
• The InvoiceDetail > Amount node should be the total for the line item include freight, shipping, discount, etc.  The sum of these values will be used to determine the total of the invoice.

Location Node

• This is an optional child element to the InvoiceDetail element. Allows you to define a unit number for each line item.
• Unit numbers can be obtained via Property/GetUnits.
• Each unit detail represents one line-item on an invoice. Each unit detail can have no more than one location.

Example XML - PostAccountsPayable4_0.xml

<AccountsPayable>

         <AccountsPayableRequest>

                 <Vendor>

                         <ActionType>InvoicePayment</ActionType>

                         <IdRef>abc</IdRef>

                         <Invoice>

                                <CreditMemo>false</CreditMemo>

                                 <DueDate>2014-01-30</DueDate>

                                 <IdRef>501</IdRef>

                                 <ImageUrl>http://www.image.com/invoice501.pdf</ImageUrl>

                                 <InvoiceNumber>501</InvoiceNumber>

                                 <InvoiceDate>2014-01-28</InvoiceDate>

                                 <AccountingDate>2014-01-28</AccountingDate>

                                 <InvoiceDetails>

                                         <InvoiceDetail>

                                                 <Amount>10.00</Amount>

                                                 <AccountIdentifier>7200</AccountIdentifier>

                                                 <LineNumber>1</LineNumber>

                                                 <Notes>Charge for painting services</Notes>

                                                 <ProductQty>1</ProductQty>

                                                 <UnitPrice>10.00</UnitPrice>

                                                <Location>12</Location>

                                         </InvoiceDetail>

                                         <InvoiceDetail>

                                                 ...

                                         </InvoiceDetail>

                                 </InvoiceDetails>

                                 <Memo>

                                         <Text>Invoice from ABC Painting</Text>

                                 </Memo>

                                 <Notes>Please submit payment immediately</Notes>

                                 <OrderDate>2014-01-27</OrderDate>

                                 <TotalAmount>10.00</TotalAmount>

                                 <Payment>

                                         <AmountPaid>10.00</AmountPaid>

                                         <CheckNumber>1234</CheckNumber>

                                         <CheckDate>2014-01-27</CheckDate>

                                         <Description>Payment for paint job</Description>

                                 </Payment>

                         </Invoice>

                 </Vendor>

                 <Vendor>

                         ...

                 </Vendor>

         </AccountsPayableRequest>

</AccountsPayable>

Response

When submitting a request to the PostAccountsPayable4_0, you will receive a response following the pattern below. The response will include information about the method that was called as well as a status indicating whether or not the request was successful.  If there was an error in the request, the ErrorDescription node will identify any problems with the request.

<ResMan>

          <MethodName>PostAccountsPayable4_0</MethodName>

          <Status>Success</Status>

          <AccountID>400</AccountID>

          <PropertyID>07413576-f764-44c6-be35-df4139deec01</PropertyID>

          <ErrorDescription />

</ResMan>

Possible Errors

If any errors occur while parsing the XML sent to the API, they will be returned in the ErrorDescription node, which contains a list of error messages logged while parsing the XML.

The following errors will be logged and returned:

• "The selected property does not have a manager selected" - When posting an invoice, we must tie the invoice to an employee at the property.  By default, the manager that is associated with property issued
• "Missing AccountsPayable AccountsPayableRequest node" - An AccountsPayable node is missing an AccountsPayableRequest node
• "Missing Vendor ActionType node" - A Vendor node is missing an ActionType node
• "Missing Vendor ActionType with a value of InvoicePayment" - A Vendor ActionType node must have a value of InvoicePayment
• "Missing Vendor IdRef node" - A Vendor node is missing an IdRef node
• "Vendor [vendor] could not be found" - The Vendor IdRef node value could not be used to find an existing vendor
• "Missing Vendor Invoice node" - A Vendor node is missing an Invoice node
• "Missing Invoice DueDate node" - An Invoice node is missing a DueDate node
• "Missing Invoice InvoiceDate node" - An Invoice node is missing an InvoiceDate node
• "Missing Invoice OrderDate node" - An Invoice node is missing an OrderDate node
• "Missing Invoice IdRef node" - An Invoice node is missing an IdRef node
• "Missing Invoice Memo node" - An Invoice node is missing a Memo node
• "Missing Memo Text node" - A Memo node is missing a Text node
• "Missing Invoice InvoiceDetails node" - An Invoice node is missing an InvoiceDetails node
• "Missing InvoiceDetail Amount node" - An InvoiceDetail node is missing an Amount node
• "Unable to parse the InvoiceDetail Amount value [value]" - The Amount value cannot be converted to a decimal
• "Missing InvoiceDetail AccountIdentifier node" - An InvoiceDetail node is missing an AccountIdentifier node
• "GL Account [account] could not be found" - The AccountIdentifier value does not match an existing GL Account Number
• "Missing InvoiceDetail LineNumber node" - An InvoiceDetail node is missing a LineNumber node
• "Unable to parse the InvoiceDetail LineNumber value [value]" - The LineNumber value cannot be converted to an integer
• "Missing InvoiceDetail ProductQty node" - An InvoiceDetail node is missing a ProductQty node
• "Unable to parse the InvoiceDetail ProductQty value [value]" - The ProductQty value cannot be converted to a decimal
• "Missing InvoiceDetail UnitPrice node" - An InvoiceDetail node is missing a UnitPrice node
• "Unable to parse the InvoiceDetail UnitPrice value [value]" - The UnitPrice value cannot be converted to a decimal
• "Missing Payment AmountPaid node" - A Payment node is missing an AmountPaid node
• "Missing Invoice TotalAmount node" - An Invoice node is missing a TotalAmount node
• "Payment AmountPaid value can't be greater than the sum of the InvoiceDetails Amount values" - A single AmountPaid value must be less than all of the invoice amounts
• "Payment AmountPaid value can't be greater than the Invoice TotalAmount value" - A single AmountPaid value must be less than the total amount
• "Unable to parse the Payment CheckNumber value [value]" - The CheckNumber value cannot be converted to an integer
• "Payment Description must be less than 200 characters" - The description is too long
• "This property does not have a default bank account selected" - The given property needs a default bank account in order to pay invoices
• "Missing Payment CheckDate node" - A Payment node is missing a Payment node
• "Payment CheckDate [Date] is in a closed period" - The date must be in an open period
• "Cannot make a payment in an individual credit memo" - The value of the CreditMemo node must be false in order to make invoice payments.
• "This property does not have a manager selected" - The given property needs a manager selected
• "Invoice date [Date] is in a closed period" - The date must be in an open period
• “Unable to match the InvoiceDetail Location value [UnitNumber] to an existing unit for property [PropertyID].” - This property doesn’t have a unit with this number. Use the GetUnits method to obtain a list of unit numbers you can use or remove this optional element to continue to create the invoice without a defined unit.

Below is an example response if an Invoice node is missing a Memo node:

<ResMan>

  <MethodName>PostAccountsPayable4_0</MethodName>

  <Status>Error</Status>

  <AccountID>400</AccountID>

  <PropertyID>07413576-f764-44c6-be35-df4139deec01</PropertyID>

  <ErrorDescription>An Invoice node is missing a Memo node</ErrorDescription>

</ResMan>

Unused Nodes

There is some data supported in the MITS specification that is not currently supported by ResMan. The following elements will not be used if sent:

• AccountsPayable

• AccountsPayableRequest

• Vendor

• ActionTypeOtherDescription
• Address
• AllowDiscountDaysAfterInvoice
• ApartmentAccountNumer
• ChangeOrderIdentifier
• Contact
• ConsolidatePayments
• DiscountDays
• DiscountPercent
• Email
• FirstName
• GovernmentID
• HoldPayments
• IdentificationCode
• InActive
• InActiveDate
• Invoice

• AccountsPayableAccountIdentifier
• Adjustment
• BatchIdentifier
• CashAccountIdentifier
• ConsolidateCheck
• DiscountDate
• DiscountPercent
• DiscountAmount
• ElectronicSuplierInvoiceFlag
• ExemptFrom1099
• FreightAmount
• InvoiceDetails

• InvoiceDetail

• CheckPostMonth
• CheckPostYear
• CategoryIdentifier
• ContractIdentifier
• ConstructionRetention
• ConstructionRetentionAmount
• ConstructionCostCode
• FreightAmount
• JobIdentifier
• PaymentIdentifier
• PropertyIdentifier
• SerialNumber
• Sku
• TaxAmount
• UnitOfMeasure
• WarrantyInfo

• InvoiceNumber
• Memo

• EventType
• EventTypeOtherDescription
• EventDate
• Responsible

• OrderNumber
• Payment
• PostMonth
• PurchaseOrderNumber
• ReferenceInvoiceNumber
• RemittanceSlipRequired
• ServicePeriod
• ServiceType
• ServiceTypeOtherDescription
• SubTotal
• EndUserLocationIdentifier
• TaxAmount
• TotalAmount
• TotalAmountPaid
• TransactionIdentifier
• Unpaid
• UserCode

• InsuranceDetails
• LastName
• NoSignatureRequired
• NoSignatureAmount
• PhaseCodeIdentifier
• PurchaseOrderRequired
• Receive1099
• RetentionPercent
• Salutation
• SalesTaxPercent
• SubContractor
• URL
• UsualAccountIdentifier

• AccountsPayableResponse
• CustomRecords

GetAccountsPayable4_0

This method is to be used to get invoice records in ResMan for a given property. This endpoint only returns invoices that the specified integration partner entered via the API.

Request

Data is added by performing a HTTP Post to https://api.myresman.com/MITS/GetAccountsPayable4_0  supplying the listed parameters below.  

Parameters

The following demonstrates one way of submitting a request to the PostAccountsPayable4_0 method using C#.

NameValueCollection postData = new NameValueCollection();

// Integration Partner values

postData["IntegrationPartnerID"] = "1000";

postData["ApiKey"] = "6aw7y9m3m04849lqld6em9sudl5fg01u";                                      

// Account and property specific data

postData["AccountID"] = "400";

postData["PropertyID"] = "07413576-f764-44c6-be35-df4139deec01";

// Method specific parameters

postData["StartDate"] = “2016-01-01”;

postData["EndDate"] = “2016-01-01”;

string url = "https://api.myresman.com/MITS/GetAccountsPayable4_0";

WebClient client = new WebClient();                

byte[] response = client.UploadValues(url, "POST", postData);

string strResponse = System.Text.Encoding.Default.GetString(response);

Response

When submitting a request to the GetAccountsPayable4_0, you will receive a response following the pattern below. The response will include information about the method that was called as well as a status indicating whether or not the request was successful.  If there was an error in the request, the ErrorDescription node will identify any problems with the request.

<ResMan>

        <MethodName>GetAccountsPayable4_0</MethodName>

        <Status>Success</Status>

        <AccountID>1</AccountID>

        <PropertyID>11111111-1111-1111-1111-111111111111</PropertyID>

        <Response>

            <AccountsPayable xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

                <AccountsPayableRequest>

                    <Vendor>

                        <AllowDiscountDaysAfterInvoice>false</AllowDiscountDaysAfterInvoice>

                        <ConsolidatePayments>false</ConsolidatePayments>

                        <DiscountDays>0</DiscountDays>

                        <DiscountPercent>0</DiscountPercent>

                        <HoldPayments>false</HoldPayments>

                        <InActive>false</InActive>

                        <InActiveDate>0001-01-01T00:00:00</InActiveDate>

                        <Invoice>

                            <Adjustment>false</Adjustment>

                            <CreditMemo>false</CreditMemo>

                            <ConsolidateCheck>false</ConsolidateCheck>

                            <DueDate>2017-03-20T00:00:00</DueDate>

                            <DiscountDate>0001-01-01T00:00:00</DiscountDate>

                            <DiscountPercent>0</DiscountPercent>

                            <DiscountAmount>0</DiscountAmount>

                            <ExemptFrom1099>false</ExemptFrom1099>

                            <FreightAmount>0</FreightAmount>

                            <IdRef>1</IdRef>

                            <InvoiceDate>2017-03-20T00:00:00</InvoiceDate>

                            <InvoiceDetails>

                                <InvoiceDetail>

                                    <Amount>10.0000</Amount>

                                    <AccountIdentifier>6760</AccountIdentifier>

                                    <ConstructionRetention>false</ConstructionRetention>

                                    <ConstructionRetentionAmount>0</ConstructionRetentionAmount>

                                    <Notes>Painting</Notes>

                                    <TaxAmount>0</TaxAmount>

                                </InvoiceDetail>

                            </InvoiceDetails>

                            <Memo>

                                <EventDate>0001-01-01T00:00:00</EventDate>

                                <Text>Painting</Text>

                            </Memo>

                            <Payment>

                                <AmountPaid xsi:nil="true" />

                                <CheckDate xsi:nil="true" />

                                <ResolvedDate xsi:nil="true" />

                            </Payment>

                            <RemittanceSlipRequired>false</RemittanceSlipRequired>

                            <SubTotal>0</SubTotal>

                            <TaxAmount>0</TaxAmount>

                            <TotalAmount xsi:nil="true" />

                            <TotalAmountPaid>10.0000</TotalAmountPaid>

                            <Unpaid>false</Unpaid>

                        </Invoice>

                        <NoSignatureRequired>false</NoSignatureRequired>

                        <NoSignatureAmount>0</NoSignatureAmount>

                        <PurchaseOrderRequired>false</PurchaseOrderRequired>

                        <Receive1099>false</Receive1099>

                        <RetentionPercent>0</RetentionPercent>

                        <SalesTaxPercent>0</SalesTaxPercent>

                        <SubContractor>false</SubContractor>

                    </Vendor>

                </AccountsPayableRequest>

            </AccountsPayable>

        </Response>

</ResMan>

Unused Nodes

There is some data supported in the MITS specification that is not currently supported by ResMan. The following elements are not used when returned:

• AccountsPayable

• AccountsPayableRequest

• Vendor

• ActionType
• ActionTypeOtherDescription
• Address
• AllowDiscountDaysAfterInvoice
• ApartmentAccountNumber
• ChangeOrderIdentifier
• CheckMemo
• Contact
• ConsolidatePayments
• DiscountDays
• DiscountPercent
• Email
• GovernmentID
• HoldPayments
• IdentificationCode
• IdRef
• InActive
• InActiveDate
• InsuranceDetails
• Invoice

• CreditMemo
• DueDate
• IdRef
• ImageURL
• InvoiceDetail

• CheckPostMonth
• CheckPostYear
• CategoryIdentifier
• ContractIdentifier
• ConstructionRetention
• ConstructionRetentionAmount
• ConstructionCostCode
• FreightAmount
• JobIdentifier
• LineNumber
• PaymentIdentifier
• ProductQuantity
• PropertyIdentifier
• TaxAmount
• Sku
• UnitPrice
• UnitOfMeasure
• WarrentySerialNo

• InvoiceNumber
• Memo
• Payment
• TotalAmount
• TotalAmountPaid