Skip to main content
GET
Get a complete-book declaration

Authorizations

Authorization
string
header
required

Integration-owned environment-specific API key. Never paste a production key into documentation tools.

Path Parameters

clientCode
string
required

Stable non-sensitive Client code authorized by the Integration grant.

Pattern: ^[A-Za-z0-9_-]{1,128}$
externalCompletionId
string
required

Caller-assigned identifier of this complete-book declaration. Reusing it with an identical body is a safe retry.

Pattern: ^[A-Za-z0-9_-]{1,128}$

Response

Accepted complete-book declaration.

acceptedAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
asOf
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
batches
string[]
required
Maximum array length: 50
Pattern: ^[A-Za-z0-9_-]{1,128}$
coveredReceivableCount
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
externalCompletionId
string
required
Pattern: ^[A-Za-z0-9_-]{1,128}$
omissions
object[]
required
Maximum array length: 100
omissionsTruncated
boolean
required

True when more than 100 Receivables were flagged; omittedReceivableCount is the exact total.

omittedReceivableCount
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
scope
enum<string>
required
Available options:
all_receivables
sourcePosition
integer
required
Required range: x <= 9007199254740991