Rechnungszahlungen API-Beispielaufrufe

Rechnungszahlungen PUT

Im Folgenden wird beschrieben, wie Sie die Coupa-API verwenden können, um eine Rechnung mit Zahlungsinformationen zu aktualisieren

Mit unserer Rechnungszahlungs-API können Sie zwei Dinge tun:

1. Aktualisieren Sie eine Rechnung mit drei Attributen: Bezahlt, Zahlungsdatum und Zahlungsvermerke.
   Coupa ermöglichte es Ihnen ursprünglich, Informationen in diese Rechnungsfelder einzugeben. Wenn Sie mehrere Zahlungen getätigt haben, müssen Sie diese zweiten Zahlungsinformationen an die Zahlungshinweise anhängen.
2. Jetzt können Sie dies tun und eine Rechnung mit einer Reihe von Zahlungsinformationen aktualisieren: Zahlungsdatum, Anmerkungen (Schecknummer) und Bezahlter Betrag.  Auf diese Weise können Sie einer einzigen Rechnung mehrere Zahlungstermine, Schecknummern und gezahlte Beträge zuweisen.

Das Kundenfeedback hat uns geholfen, den Wert des Hinzufügens weiterer Zahlungsdaten für eine einzelne Rechnung zu erkennen. Da einige Kunden immer noch die ursprüngliche Methode zur Aktualisierung von Rechnungen verwenden, haben wir uns entschieden, beide Möglichkeiten zur Aktualisierung von Rechnungen mit Zahlungsinformationen zu unterstützen.

Dies ist die URL, unter der SIE diese Informationen eingeben können:

• <your_instance_URL>/api/invoices/<invoice id>
• In der Regel würden Sie die Rechnungsnummer und den Lieferanten verwenden, um die richtige Rechnungs-ID zu finden, damit sie im PUT verwendet werden kann

Sie können Zahlungen mit der Invoice Payments API (../invoices/<invoice_id>endpoint) über einen Put-Aufruf AUF eine vorhandene Rechnung buchen. Die Nutzlast des PUT kann entweder als XML oder json mit einem von mehreren akzeptierten Formaten formatiert werden. 

Wir haben es auf die URL gepostet:  PUT https://<instance>.coupahost.com/api/invoices/<invoice id> 

Beispiel: Zahlungsinformationen zu einer vorhandenen Rechnung hinzufügen

In diesen Beispielen fügen wir einer vorhandenen Rechnung mithilfe der folgenden Felder Zahlungsinformationen hinzu: Bezahlt, Kennzeichen, Zahlungshinweise und Zahlungsdatum.

Wir haben eine Nutzlast entweder in XML oder json unter der URL: https://.coupahost.com/api/invoices/<instance> veröffentlicht<invoice id>

Die Nutzdaten können in einem von mehreren unterstützten Formaten vorliegen, die zur programmgesteuerten Aufzeichnung von Zahlungen über diese Schnittstelle verwendet werden. Mehr als ein paar Beispiele folgen im Folgenden.

Beispiele für XML-Nutzdaten

Und hier ist ein Beispiel für ein XML-Nutzlastschema, das weiterhin unterstützt wird.

<?xml version="1.0" encoding="UTF-8"?>

<invoice-header>

	 <paid type="boolean">wahr</paid>

	 <payment-date type="datetime">2009-06-23T00:00:00-08:00</payment-date>

	 <payment-notes>SCHECK|#1003|USD|989,00|VOLLSTÄNDIG BEZAHLT|</payment-notes>

	 <payments type="array">

			<payment>

				 <amount-paid>989,00</amount-paid>

				 <notes>1003</notes>

				 <payment-date>2009-06-23</payment-date>

			</payment>

	 </payments>

</invoice-header>

Hier ist ein weiteres Beispiel für XML-Nutzdaten: 

<?xml version="1.0" encoding="UTF-8"?>

<invoice-header>

	 <invoice-date type="datetime">"22.10.2019 00:00:00 -0900"</invoice-date>

	 Rechnungsnummer_<invoice-number>1571292051.310760975</invoice-number>

	 <payments type="array">

			<payment>

				 <amount-paid>5,00</amount-paid>

				 <notes>1003</notes>

				 <payment-date>22.10.2019</payment-date>

			</payment>

	 </payments>

</invoice-header>

Und hier ist ein Beispiel für mehrere Zahlungen mit XML:

<?xml version="1.0" encoding="UTF-8"?>

<invoice-header>

	 <payments type="array">

			<payment>

				 <amount-paid>4,00</amount-paid>

				 <notes>1003</notes>

				 <payment-date>2009-06-23</payment-date>

			</payment>

			<payment>

				 <amount-paid>5,00</amount-paid>

				 <notes>1004</notes>

				 <payment-date>2009-06-23</payment-date>

			</payment>

	 </payments>

</invoice-header>

Und eine alte Beispiel-XML-Nutzlast (noch unterstützt), die eine vorhandene Rechnung mit mehreren Schecknummern mithilfe von Zahlungshinweisen aktualisiert.  Dies verwendet die Felder: Bezahlt, Schecknummer und Zahlungsdatum.

<?xml version="1.0" encoding="UTF-8"?>

<invoice-header>

	 <paid type="boolean">wahr</paid>

	 <payment-date type="datetime">2009-06-23T00:00:00-08:00</payment-date>

	 <payment-notes>SCHECK|#1003|USD|989,00|VOLLSTÄNDIG BEZAHLT|</payment-notes>

	 <payments type="array">

			<payment>

				 <amount-paid type="decimal" nil="true">100,23</amount-paid>

				 <notes nil="true">232</notes>

				 <payment-date type="datetime" nil="true">2010-09-25T02:22:11Z</payment-date>

			</payment>

			<payment>

				 <amount-paid type="decimal" nil="true">9032,32</amount-paid>

				 <notes nil="true">233</notes>

				 <payment-date type="datetime" nil="true">2010-09-25T02:22:11Z</payment-date>

			</payment>

	 </payments>

</invoice-header>

Beispiele für JSON-Nutzdaten

Um eine JSON-Nutzlast zu verwenden, können Sie eines der folgenden Beispiele als Formatmodell verwenden.

Datenformat 1:

{

	"Zahlungen": 

	{

		"Zahlung":

			{ "check_number": "1234567", "AMOUNT_Paid": „199.98“, „Hinweise“: "String", "payment_date": "12.09.2019" }

	},

	"paid": "falsch",

	"payment_date": "9/11/2019",

	"payment_notes": "Teilzahlung mit einem Zahlungsscheck."

}

 Datenformat 2:

{

	"Zahlungen": 

	{

		"payment": [

			{ "check_number": "test_check_number", "amount_paid": „510“, „Hinweise“: "A payment note", "payment_date": "9/12/2019" },

			{ "check_number": "test_check_number", "amount_paid": "53", "Hinweise": "A payment note", "payment_date": "9/11/2019" }]

	},

	"paid": "falsch",

	"payment_date": "9/11/2019",

	"payment_notes": „Eine Teilzahlung mit zwei Schecks.“

}

Datenformat 3: 

{

	"Zahlungen": [

		{ "check_number": "test_check_number", "amount_paid": „510“, „notes“: „payment_note“, „payment_date“: "9/12/2019" },

		{ "check_number": "test_check_number", "amount_paid": „53“, „Notes“: „payment_note“, „payment_date“: "9/11/2019" }

	],

	"paid": "falsch",

	"payment_date": "9/11/2019",

	"payment_notes": „Zwei Zahlungen mit zwei Schecks.“

}

Datenformat 4: 

{

	"paid": "wahr",

	"Zahlungsdatum": "2019-08-13T00:00:00Z",

	"payment-notes": "eProc-Gutschein #TRM-19-0009584-PV/THB",

	"payments": {

		 "payment" :	[

			 {

				 "Kreditorenart": "Rechnungsüberschrift",

				 "payable-id": "4835",

				 "bezahlter Betrag": "49.00",

				 "Notes": "TRM-19-0009584-PV",

				 "Zahlungsdatum": "2019-08-13T00:00:00Z"

			 },

			{

				 "Kreditorenart": "Rechnungsüberschrift",

				 "payable-id": "4835",

				 "bezahlter Betrag": "51.00",

				 "Notes": "TRM-19-0009584-PV",

				 "Zahlungsdatum": "2019-08-13T00:00:00Z"

			 }

		]

	}

}

Rückgaben

Erfolgreiche Anfragen werden zurückgegeben: Http 200 wurde erstellt. Der Text der Antwort enthält die Zahlungsinformationen und die Rechnung, die aktualisiert wurde.

Nicht erfolgreiche Anfragen werden zurückgegeben: Http 400 Fehlerhafte Anfrage. Der Text der Antwort enthält Validierungsfehler, die als XML formatiert sind.

Feld Definitionen