| Payload |
| Code Block |
|---|
| language | js |
|---|
| title | JSON Schema |
|---|
| collapse | true |
|---|
| {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"external": {
"type": "object",
"properties": {
"orderId": {
"description": "",
"type": "string"
},
"orderConsolidatorId": {
"type": "string"
}
},
"required": [
"orderId",
"orderConsolidatorId"
]
},
"paymentDate": {
"type": "datestring"
},
"parentGuardian": {
"type": "object",
"properties": {
"refId": {
"type": "string",
"maxLength": 36,
"minLength": 36
},
"document": {
"type": "string"
}
},
"required": [
"refId",
"document"
]
},
"paymentMethod": {
"type": "string"
},
"conciliationAccount": {
"type": "string"
},
"price": {
"type": "number",
"exclusiveMinimum": 0
},
"originalPrice": {
"type": "number",
"exclusiveMinimum": 0
},
"itemList": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": [
{
"type": "object",
"properties": {
"articleRefId": {
"type": "string",
},
"maxLength": 36,
"minLength": 36
},
"student": {
"type": "object",
"properties": {
"refId": {
"type": "string",
},
"personRefId"maxLength": {36,
"typeminLength": "string"36
},
},
"personRefId": {
"requiredtype": ["string",
"refIdmaxLength": 36,
"personRefIdminLength": 36
]}
},
"totalItemrequired": {[
"typerefId": "integer",
"personRefId"
]
},
"pricetotalItem": {
"type": "number"
"integer",
"exclusiveMinimum": 0
},
"originalPriceprice": {
"type": "number",
"exclusiveMinimum": 0
},
"porcentageTaxoriginalPrice": {
"type": "integer""number",
"exclusiveMinimum": 0
},
"taxesporcentageTax": {
"type": "integer"
},
"salesTypetaxes": {
"type": "stringinteger"
},
"salesChannelsalesType": {
"type": "string"
},
"salesOptionsalesChannel": {
"type": "string"
},
"componentListsalesOption": {
"type": "arraystring",
},
"componentList": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"articleRefId": {
"type": "string",
},
"maxLength": 36,
"minLength": 36
},
"totalItem": {
"type": "integer",
"exclusiveMinimum": 0
},
"price": {
"totalItemtype": {"number",
"typeexclusiveMinimum": "integer"0
},
"priceoriginalPrice": {
"type": "number",
"exclusiveMinimum": 0
},
"originalPricemarkupPorcentage": {
"type": "number"
},
"markupPorcentagetaxes": {
"type": "number"
},
"taxesporcentageTax": {
"type": "number"
},
"porcentageTaxdiscountList": {
"type": "numberarray"
},
,
"discountListuniqueItems": {true,
"typeminItems": "array"1,
"items": [
{
"type": "object",
"properties": {
"porcentage": {
"porcentagetype": {"number",
"typeexclusiveMinimum": "number"0
},
"reason": {
"type": "string"
},
"amount": {
"type": "number",
"exclusiveMinimum": 0
}
},
"required": [
"porcentage",
"reason",
"amount"
]
}
]
}
},
"required": [
"articleRefId",
"totalItem",
"price",
"originalPrice",
"markupPorcentage",
"taxes",
"porcentageTax",
"discountList"
]
}
]
}
},
"required": [
"articleRefId",
"student",
"totalItem",
"price",
"originalPrice",
"porcentageTax",
"taxes",
"salesType",
"salesChannel",
"salesOption",
"componentList"
]
}
]
},
"freight": {
"type": "object",
"properties": {
"transportName": {
"type": "string"
},
"transportPhone": {
"type": "string"
},
"transportCode": {
"type": "string"
},
"orderNote": {
"type": "string"
},
"orderFreightValue": {
"type": "number"
},
"orderDeliveryForecast": {
"type": "string"
},
"orderEstablishment": {
"type": "string"
}
},
"required": [
"transportName",
"transportPhone",
"transportCode",
"orderNote",
"orderFreightValue",
"orderDeliveryForecast",
"orderEstablishment"
]
},
"addressList": {
"type": "array",
"uniqueItems": true,
"minItems": 2,
"items": [
{
"type": "object",
"properties": {
"address": {
"type": "object",
"properties": {
"addressType": {
"type": "string"
},
"street": {
"type": "string"
},
"outdoorNumber": {
"type": "string"
},
"interiorNumber": {
"type": "string"
},
"neighborhood": {
"type": "string"
},
"city": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"county": {
"type": "object",
"properties": {
"refId": {
"type": "string",
"maxLength": 36,
"minLength": 36
},
"countyCode": {
"type": "string"
}
},
"required": [
"refId",
"countyCode"
]
},
"contact": {
"type": "string"
},
"phone": {
"type": "string"
},
"phone2": {
"type": "string"
},
"position": {
"type": "string"
},
"officeHours": {
"type": "string"
},
"email": {
"type": "string"
},
"timeZone": {
"type": "object",
"properties": {
"refId": {
"type": "string",
"maxLength": 36,
"minLength": 36
}
},
"required": [
"refId"
]
},
"language": {
"type": "object",
"properties": {
"refId": {
"type": "string",
"maxLength": 36,
"minLength": 36
}
},
"required": [
"refId"
]
},
"active": {
"type": "boolean"
}
},
"required": [
"addressType",
"street",
"outdoorNumber",
"interiorNumber",
"neighborhood",
"city",
"postalCode",
"county",
"contact",
"phone",
"phone2",
"position",
"officeHours",
"email",
"timeZone",
"language",
"active"
]
}
},
"required": [
"address"
]
}
]
},
"transaction": {
"type": "object",
"properties": {
"installments": {
"type": "number",
"exclusiveMinimum": 0
}
}
}
},
"required": [
"external",
"paymentDate",
"parentGuardian",
"paymentMethod",
"conciliationAccount",
"price",
"originalPrice",
"itemList",
"freight",
"addressList",
"transacciontransaction"
]
} |
| Code Block |
|---|
| language | js |
|---|
| title | Ejemplo - Pago por paquete |
|---|
| collapse | true |
|---|
| {
"external": {
"orderId": "9d4d296d-f9c7-4ce8-96c5-9721cdd2c8d5",
"orderConsolidatorId": "9d4d296d-f9c7-4ce8-96c5-9721cdd2c8d5"
},
"paymentDate": "2023-06-07T16:21:38+00:00",
"parentGuardian": {
"refId": "00000000-0000-1000-0000-000012282310",
"document": "03915826588"
},
"paymentMethod": "TCV",
"conciliationAccount": "YAPY",
"price": 1118.5200,
"originalPrice": 4406.8000,
"discountList": [
{
"porcentage": 74.6183,
"amount": 3288.2800
}
],
"itemList": [
{
"articleRefId": "00000000-0000-1000-0000-000000118094",
"student": {
"refId": "00000000-0000-1000-0000-000020096053",
"personRefId": "00000000-0000-1000-0000-000012271661"
},
"totalItem": 1,
"price": 559.2617,
"originalPrice": 2203.398,
"discountList": [
{
"porcentage": 23.7097,
"reason": "COM",
"amount": 522.4191
},
{
"porcentage": 66.73,
"reason": "FFS",
"amount": 1121.7172
}
],
"porcentageTaxes": 0,
"taxes": 0,
"salesType": "VENTA",
"salesChannel": "ALU",
"installments": 1
},
{
"articleRefId": "00000000-0000-1000-0000-000000118095",
"student": {
"refId": "00000000-0000-1000-0000-000020096149",
"personRefId": "00000000-0000-1000-0000-000012271845"
},
"totalItem": 1,
"price": 559.2617,
"originalPrice": 2203.398,
"discountList": [
{
"porcentage": 23.7097,
"reason": "COM",
"amount": 522.4191
},
{
"porcentage": 66.73,
"reason": "HP",
"amount": 1121.7172
}
],
"porcentageTaxes": 0,
"taxes": 0,
"salesType": "VENTA",
"salesChannel": "ALU",
"installments": 1
}
],
"freight": {
"transportName": "",
"transportPhone": "",
"transportCode": "",
"orderNote": "",
"orderFreightValue": 0,
"orderDeliveryForecast": "dd/mm/yyyy",
"orderEstablishment": ""
},
"addressList": [
{
"address": {
"addressType": "Physical",
"street": "Rua Gavião Peixoto",
"outdoorNumber": "313",
"interiorNumber": "",
"neighborhood": "Icaraí",
"city": "RIO DE JANEIRO",
"postalCode": "24230092",
"county": {
"refId": "00000000-0000-1000-0000-000000020226",
"countyCode": "BE402DF"
},
"contact": "Alfredo Pai",
"phone": "",
"phone2": "12345678901",
"position": "Contacto Principal",
"officeHours": "",
"email": "test@test.com",
"timeZone": {
"refId": "00000000-0000-1000-0000-000000000028"
},
"language": {
"refId": "00000000-0000-1000-0000-000000000017"
},
"active": true
}
},
{
"address": {
"addressType": "Mailing",
"street": "Rua Gavião Peixoto",
"outdoorNumber": "313",
"interiorNumber": "",
"neighborhood": "Icaraí",
"city": "RIO DE JANEIRO",
"postalCode": "24230092",
"county": {
"refId": "00000000-0000-1000-0000-000000020226",
"countyCode": "BE402DF"
},
"contact": "Alfredo Pai",
"phone": "",
"phone2": "12345678901",
"position": "Contacto Principal",
"officeHours": "",
"email": "test@test.com",
"timeZone": {
"refId": "00000000-0000-1000-0000-000000000028"
},
"language": {
"refId": "00000000-0000-1000-0000-000000000017"
},
"active": true
}
}
],
"transaction": {}
} |
| Code Block |
|---|
| language | js |
|---|
| title | Ejemplo - Pago fraccionado |
|---|
| collapse | true |
|---|
| {
"external": {
"orderId": "9d4d296d-f9c7-4ce8-96c5-9721cdd2c8d5",
"orderConsolidatorId": "9d4d296d-f9c7-4ce8-96c5-9721cdd2c8d5"
},
"paymentDate": "2023-06-07T16:21:38+00:00",
"parentGuardian": {
"refId": "00000000-0000-1000-0000-000012431581",
"document": "27288324800"
},
"paymentMethod": "PWM",
"conciliationAccount": "",
"price": 760.73,
"originalPrice": 760.73,
"itemList": [
{
"articleRefId": "00000000-0000-1000-0000-000000118090",
"student": {
"refId": "00000000-0000-1000-0000-000020700764",
"personRefId": "00000000-0000-1000-0000-000012147907"
},
"totalItem": 1,
"price": 741.12,
"originalPrice": 741.12,
"porcentageTax": 0,
"taxes": 0,
"salesType": "VENTA",
"salesChannel": "ALU",
"salesOption": "OB",
"installments": 1,
"componentList": [
{
"articleRefId": "00000000-0000-1000-0000-000000094355",
"totalItem": 1,
"price": 143.2523,
"originalPrice": 219,
"markupPorcentage": 20,
"taxes": 0,
"porcentageTax": 0,
"discountList": [
{
"porcentage": 45.49,
"reason": "VEFR",
"amount": 119.5477
}
]
},
{
"articleRefId": "00000000-0000-1000-0000-00000094584",
"totalItem": 1,
"price": 66.7202,
"originalPrice": 102,
"markupPorcentage": 20,
"taxes": 0,
"porcentageTax": 0,
"discountList": [
{
"porcentage": 45.49,
"reason": "VEFR",
"amount": 55.6798
}
]
},
{
"articleRefId": "00000000-0000-1000-0000-000000094294",
"totalItem": 1,
"price": 138.6734,
"originalPrice": 212,
"markupPorcentage": 20,
"taxes": 0,
"porcentageTax": 0,
"discountList": [
{
"porcentage": 45.49,
"reason": "VEFR",
"amount": 115.7266
}
]
},
{
"articleRefId": "00000000-0000-1000-0000-000000094344",
"totalItem": 1,
"price": 138.6734,
"originalPrice": 212,
"markupPorcentage": 20,
"taxes": 0,
"porcentageTax": 0,
"discountList": [
{
"porcentage": 45.49,
"reason": "VEFR",
"amount": 115.7266
}
]
},
{
"articleRefId": "00000000-0000-1000-0000-000000094291",
"totalItem": 1,
"price": 138.6734,
"originalPrice": 212,
"markupPorcentage": 20,
"taxes": 0,
"porcentageTax": 0,
"discountList": [
{
"porcentage": 45.49,
"reason": "VEFR",
"amount": 115.7266
}
]
},
{
"articleRefId": "00000000-0000-1000-0000-000000094604",
"totalItem": 1,
"price": 115.1251,
"originalPrice": 176,
"markupPorcentage": 20,
"taxes": 0,
"porcentageTax": 0,
"discountList": [
{
"porcentage": 45.49,
"reason": "VEFR",
"amount": 96.0749
}
]
}
]
}
],
"freight": {
"transportName": "",
"transportPhone": "",
"transportCode": "",
"orderNote": "",
"orderFreightValue": 19.61,
"orderDeliveryForecast": "2023-06-07T16:21:38+00:00",
"orderEstablishment": ""
},
"addressList": [
{
"address": {
"addressType": "Physical",
"street": "Rua Gavião Peixoto",
"outdoorNumber": "313",
"interiorNumber": "",
"neighborhood": "Icaraí",
"city": "RIO DE JANEIRO",
"postalCode": "24230092",
"county": {
"refId": "00000000-0000-1000-0000-000000020226",
"countyCode": "BE402DF"
},
"contact": "Alfredo Pai",
"phone": "",
"phone2": "12345678901",
"position": "Contacto Principal",
"officeHours": "",
"email": "test@test.com",
"timeZone": {
"refId": "00000000-0000-1000-0000-000000000028"
},
"language": {
"refId": "00000000-0000-1000-0000-000000000017"
},
"active": true
}
},
{
"address": {
"addressType": "Mailing",
"street": "Rua Gavião Peixoto",
"outdoorNumber": "313",
"interiorNumber": "",
"neighborhood": "Icaraí",
"city": "RIO DE JANEIRO",
"postalCode": "24230092",
"county": {
"refId": "00000000-0000-1000-0000-000000020226",
"countyCode": "BE402DF"
},
"contact": "Alfredo Pai",
"phone": "",
"phone2": "12345678901",
"position": "Contacto Principal",
"officeHours": "",
"email": "test@test.com",
"timeZone": {
"refId": "00000000-0000-1000-0000-000000000028"
},
"language": {
"refId": "00000000-0000-1000-0000-000000000017"
},
"active": true
}
}
],
"transaction": {}
} |
|
|---|