value-receipts

Sync a value receipt (deprecated)

Deprecated — use POST /value-receipts. Returns the receipt this customer already has for the date range (200), and creates one only if there is none (201), so calling twice does not give the customer two receipts. A receipt does not change after it is created, so a repeated call reports the same figures. Create a new receipt to report the period again with newer data.

post/value-receipts/sync

Request

  • Base URL: https://api.agentpaid.io/api/v2
  • URL: https://api.agentpaid.io/api/v2/value-receipts/sync
  • Auth: HTTP bearer

Request body

customerIdstring

Mutually exclusive with externalCustomerId. Exactly one is required.

externalCustomerIdstring

Mutually exclusive with customerId. Exactly one is required.

startDatestring date-time required
endDatestring date-time required
orderIdstring

Mutually exclusive with product. Provide at most one.

Response

200

idstring required
statusstring required

Always "posted".

publicUrlTokenstring required
publicUrlstring uri required
generatedAtstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.