ACCOUNTING MarkBuyerBillAsReceived API Version 1

Aldo Lambruschini

Modified on: Mon, 18 Jan, 2021 at 9:46 AM

ACCOUNTING MarkBuyerBillAsReceived API Version 1

Updated on 2014-07-09
Current Version: Version 1
Deprecated Version: NA
Requests Allowed: GET&SOAP

Summary:

"Bill Successfully Updated" or "Bill Marked As Received". Along with payment_amount and bill_amount

Resource/WSDL Page:

http://<your_domain_here>/api/1/accounting.asmx?op=MarkBuyerBillAsReceived

Parameters

api_key Required Type: STRING Length (Max/Min): 50	Must be a valid API key (existing and NOT expired) Example Values: rYwtD48irQ0CiHRiuaB9abASO3e8O7GS
bill_id Required Type: INT Length (Max/Min): NA	You can use the ExportBuyerBills API to retrieve this value. Example Values: 1641
payment_amount Required Type: DECIMAL Length (Max/Min): NA	Example Values: 70.01
payment_type_id Required Type: BYTE Length (max/Min): NA	Passing value of Zero is a wildcard value. You can obtain payment type ID using the following API:GET PaymentTypes API Example Values: 0
invoice_number Required Type: STRING Length (Max/Min): 50	NULL to erase it, empty string to skip it Example Values: NULL
verification_code Required Type: STRING Length (Max/Min): NA	NULL to erase it, empty string to skip it Example Values: NULL
date_payment_received Required Type: DATETIME Length (Max/min): NA	Must be one of the following formats allowed formats: "YYYY-mm-dd", "mm-dd-YYYY" Example Values: 2014-06-01
date_payment_received_modification_type Required Type: MODIFICATION_TYPE Length (Max/Min): NA	Use this to not apply or remove the date Example Values: Must use one of these values: do_not_change, change, remove
apply_credit_to_buyer Required Type: BOOL Length (Max/Min): NA	Example Values: FALSE
notes Required Type: STRING Length (Max/Min): 250	NULL to erase it, empty string to skip it Example Values:

**Note all optional parameters still need to be passed through in the actual call. These parameters do not need a value (therefore you can use a null value).

Example Request

GET

https://demo-new.cakemarketing.com/api/1/accounting.asmx/MarkBuyerBillAsReceived?api_key=3YmDJeT3VHTFhDqAjr2OlQ&bill_id=1641&payment_amount=60&payment_type_id=0&invoice_number=&verification_code=&date_payment_received=%202014-06-05&date_payment_modification_type=do_not_change&apply_credit_to_buyer=FALSE&notes&date_payment_received_modification_type=do_not_change&notes=none

Sample XML Response:

<mark_buyer_bill_as_received_accounting_response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://cakemarketing.com/api/1/">

<success>true</success>

<message>Bill Successfully Updated</message>

<payment_amount>

<currency_id>1</currency_id>
<amount>60</amount>
<formatted_amount>$60.00</formatted_amount>

</payment_amount>

<bill_amount>

<currency_id>1</currency_id>
<amount>60.0000</amount>
<formatted_amount>$60.00</formatted_amount>

</bill_amount>

</mark_buyer_bill_as_received_accounting_response>

Example Error Messages:

Error Message	Likely Cause
Invalid API key	API key does not exist or is expired
Invalid Invoice Number	Length exceeds 50 characters
Invalid Notes	Length exceeds 250 characters
Invalid Bill ID	Bill could not be found using the provided id
Invalid Payment Type ID	Payment ID passed is not valid
Invalid Verification Code	Length exceeds 50 characters