Skip to main content

Document

A file the merchant keeps with their agreements — the signed paper, a certificate, a rate card.

type Document {
  sizeBytes: Int!
  contract: Contract
  id: ID!
  fileName: String!
  contentType: String!
  status: DocumentStatus!
  uploadedAt: DateTime
}

Fields​

Document.sizeBytes ● Int! non-null scalar​

How large the file is, in bytes. For a file that has not arrived yet this is what the sender said it would be.

**Returns:** The size in bytes.

Document.contract ● Contract object​

The agreement this file belongs to, or null when it stands on its own — a certificate or a licence belongs to the merchant rather than to any one agreement.

**Returns:** The agreement, or null.

Document.id ● ID! non-null scalar​

The stable identifier of this file, unique across every merchant.

Document.fileName ● String! non-null scalar​

What the file is called, as the person who sent it named it.

Document.contentType ● String! non-null scalar​

What kind of file it is, as an IANA media type — for example application/pdf.

Document.status ● DocumentStatus! non-null enum​

Where the file has reached.

Document.uploadedAt ● DateTime scalar​

When the file was confirmed to have arrived, in UTC, or null while it has not.

Returned By​

document query

Member Of​

DocumentConnection object ● DocumentEdge object ● DocumentFinalized object ● DocumentUploadStarted object