Partner payouts - Creates a new payments export request
Met deze API kunt u een nieuwe exportaanvraag voor betalingen maken. U wordt aangeraden $filter param te gebruiken voor elke aanvraag. Zie hieronder over het gebruik van de filters en alle filters die beschikbaar zijn in de exportpagina-interface (UX) zijn ook beschikbaar via deze API, wat flexibiliteit en consistentie biedt bij het filteren van gegevens.
POST https://api.partnercenter.microsoft.com/v{version}/payouts/paymentsPOST https://api.partnercenter.microsoft.com/v{version}/payouts/payments?$filter={$filter}&enrollmentParticipantId={enrollmentParticipantId}&paymentId={paymentId}&payoutStatusUpdateTS={payoutStatusUpdateTS}&paymentAmount={paymentAmount}&payoutOrderType={payoutOrderType}&Multiple filters={Multiple filters}URI-parameters
| Name | In | Vereist | Type | Description |
|---|---|---|---|---|
|
version
|
path | True |
string |
|
|
$filter
|
query |
string |
De $filter queryparameter is een optionele parameter voor het maken van een exportbewerking. We raden u echter ten zeerste aan om $filter te gebruiken voor betere prestaties en snellere beschikbaarheid van het exportrapport. Hieronder vindt u enkele van de belangrijkste kenmerkfilters die kunnen worden gebruikt als onderdeel van de exportbewerking |
|
|
enrollment
|
query |
int |
Geregistreerd MPN-id-filter voor een exportaanvraag. Gebruik: {baseUrl}/uitbetalingen/betalingen?$filter=enrollmentParticipantId=12345 |
|
|
Multiple filters
|
query |
string |
Hier volgt een voorbeeldquery met meerdere filters voor een exportaanvraag. Gebruik: {baseUrl}/uitbetalingen/betalingen?$filter=uitbetalingStatusUpdateTS ge 2023-01-01 en uitbetalingStatusUpdateTS le 2023-05-31 en (enrollmentParticipantId eq 'XXXXXXX') en (programName eq 'CSP Direct Bill Partner') en (uitbetalingOrderType eq 'KORTING') en (paymentId eq 'xxxxxxx') |
|
|
payment
|
query |
double |
Betalingsbedrag om de betalingen voor een exportaanvraag te filteren. Gebruik: {baseUrl}/uitbetalingen/betalingen?$filter=paymentAmount ge 2000 en paymentAmount le 5000 |
|
|
payment
|
query |
int |
PaymentId-filter voor een exportaanvraag. Gebruik: {baseUrl}/uitbetalingen/betalingen?$filter=paymentId=123456 |
|
|
payout
|
query |
string |
Type uitbetalingsorder (korting, coop, kosten, verkopen) om de betalingen voor een exportaanvraag te filteren. Gebruik: {baseUrl}/uitbetalingen/betalingen?$filter=?$filter=uitbetalingOrderType='KORTING' |
|
|
payout
|
query |
string |
Datum van uitbetalingsstatus om de betalingen voor een exportaanvraag te filteren. Gebruik: {baseUrl}/uitbetalingen/transactiehistory?$filter=uitbetalingStatusUpdateTS ge 2023-03-01 en uitbetalingStatusUpdateTS le 2023-04-12 |
Aanvraagkoptekst
| Name | Vereist | Type | Description |
|---|---|---|---|
| Authorization | True |
string |
Bearer-token voor autorisatie |
| Client-Request-ID |
string |
Id van aanvraag die door de gebruiker is verstrekt |
Antwoorden
| Name | Type | Description |
|---|---|---|
| 202 Accepted |
De aanvraag is geaccepteerd voor verwerking. Kopteksten Request-ID: string |
|
| 400 Bad Request |
Er is een ontbrekende of ongeldige invoer. De hoofdtekst van het antwoord bevat de foutdetails. |
|
| 401 Unauthorized |
De aanvraag is niet geverifieerd. De client moet eerst worden geverifieerd met de partner-API-service. |
|
| 403 Forbidden |
De aanvraag is geverifieerd, maar is geweigerd omdat de beller niet over de rechten beschikt om deze aan te roepen. |
|
| 404 Not Found |
De resource is niet gevonden. |
|
| 429 Too Many Requests |
Te veel aanvragen. |
|
| 500 Internal Server Error |
De partner-API-service of een van de bijbehorende afhankelijkheden kan niet voldoen aan de aanvraag. Bellers kunnen dit opnieuw proberen. |
Definities
Microsoft.Partner.Service.PartnerPayout.Contracts.V1.Export
| Name | Type | Description |
|---|---|---|
| blobLocation |
string |
|
| processingStartDateTime |
string |
|
| requestDateTime |
string |
|
| requestId |
string |
|
| requestPath |
string |
|
| requestQueryString |
string |
|
| status |
enum:
|