Skip to main content
GET
/
invoices
/
relations
/
{id}
Retrieve an invoice relation
curl --request GET \
  --url https://api.syntage.com/invoices/relations/{id} \
  --header 'X-API-Key: <api-key>'
{
  "@id": "/invoices/relations/93a197e7-6baa-5dc5-bf8d-fb1645a770c1",
  "@type": "InvoiceRelation",
  "id": "91106968-1abd-4d64-85c1-4e73d96fb997",
  "type": 7,
  "invoice": "/invoices/92106967-2abd-5d64-95c2-4e73d96fb998",
  "relatedInvoice": "/invoices/92106967-2abd-5d64-95c2-4e73d96fb998",
  "relatedInvoiceUuid": "def404af-5eef-4112-aa99-d1ec8493b89a",
  "createdAt": "2020-01-01T12:15:00.000Z",
  "updatedAt": "2020-01-01T12:15:00.000Z"
}

Authorizations

​
X-API-Key
string
header
required

Your API key is available in the Production and Sandbox dashboards.

Path Parameters

​
id
string<uuid>
required

Response

Invoice relation response

​
@id
string<iri-reference>

Invoice Relation IRI reference

Example:

"/invoices/relations/93a197e7-6baa-5dc5-bf8d-fb1645a770c1"

​
@type
string
default:InvoiceRelation
​
id
string<uuid>

Invoice relation ID

Example:

"91106968-1abd-4d64-85c1-4e73d96fb997"

​
type
enum<number>

Invoice relation type code from the c_TipoRelacion catalog

Available options:
1,
2,
3,
4,
5,
6,
7,
8,
9
Example:

7

​
invoice
string<iri-reference>

Invoice IRI reference

Example:

"/invoices/92106967-2abd-5d64-95c2-4e73d96fb998"

​
relatedInvoice
string<iri-reference> | null

Invoice IRI reference

Example:

"/invoices/92106967-2abd-5d64-95c2-4e73d96fb998"

​
relatedInvoiceUuid
string<uuid>

The related Invoice UUID (Folio fiscal)

Example:

"def404af-5eef-4112-aa99-d1ec8493b89a"

​
createdAt
string

Date and time the resource was created

Example:

"2020-01-01T12:15:00.000Z"

​
updatedAt
string

Date and time the resource was last updated

Example:

"2020-01-01T12:15:00.000Z"