Create a work log

post

https://api.wingspan.app/v3/payments/work-logs

Create an empty work log for a PayeeEngagement, in currency (default USD). Accepts an optional work period (periodStart / periodEnd), which is required on a contractor engagement when the payer's work-logging config has requireWorkPeriod enabled. The payer can attach the work log to a pay period with payPeriodId. If externalId is supplied and already exists for the acting account, the request fails with 409 ResourceConflict; this create is not an upsert.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

externalId

string

Customer's own ID for reconciliation; accepted on create and filterable via ?filter[externalId][eq].

payeeEngagementId

string

required

currency

string

enum

Defaults to USD

Currency codes currently accepted by V3 invoice/payable create.

Allowed:

payPeriodId

string

Pay period to attach the work log to. Set by the payer.

periodStart

date-time

Start of the work period. Send together with periodEnd. Must fall within the work log's pay period. Required on a contractor engagement when the payer's work-logging config has requireWorkPeriod enabled.

periodEnd

date-time

End of the work period, on or after periodStart. Send together with periodStart. Must fall within the work log's pay period.

metadata

object

Free-form key-value pairs. Max 50 keys; key length at most 40 characters; value length at most 500 characters. Where a list endpoint declares metadata filtering, it uses the QueryQL namespace via filter[metadata.{key}][eq]=value or filter[metadata.{key}][in][]=value. Endpoints that do not declare the dynamic Metadata filter do not support Metadata filtering.

Headers

Idempotency-Key

string

length between 1 and 255

^[\x21-\x7e]{1,255}$

Optional idempotency token for authenticated POST and PATCH requests. Reusing the same key and body returns the cached response for 24 hours, except credential operations that explicitly document a 409 because one-time secret material is never cached; reusing it with a different body returns 409 IdempotencyKeyConflict. Use 1-255 printable ASCII characters.

X-Wingspan-Account

string

^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

201Work log created

400Malformed request syntax

401Unauthenticated

403Forbidden

409Conflict

422Validation error